csl_dmax.h

Configuring External Interrupts on TMS320C672x Devices

      CSL_dmaxSetupFifoDesc(&fifoObj, &setup);
     @endverbatim
 * 
 * ===========================================================================
 */
extern CSL_Status CSL_dmaxSetupFifoDesc(
    CSL_DmaxFifoDescriptor *, 
    CSL_DmaxFifoDescriptorSetup *
);

                                        
/** ===========================================================================
 *   @n@b CSL_dmaxStartAsyncTransferMulti
 *
 *   @b Description
 *   @n This function initiates dMax data transfer by toggling the appropriate
 *      bit in the ESR(Event Set Register) register for multiple events.
 *   @a CSL_dmaxStartAsyncTransferMulti.
 *
 *   @b Arguments
 *   @verbatim
 *    
 *          hDmax           Pointer to the dMax Handle Instance
 *           
 *   @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK - Successful completion
 *   @li                    CSL_EDMAX_BAD_ESR_FLAG - Bad ESR Flag
 *   @li                    CSL_ESYS_ BADHANDLE - Invalid CSL handle
 *
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  DMAX registers are configured 
 *
 *   @b  Modifies
 *   @n  DMAX registers
 *
 *   @b Example
 *   @verbatim  
 *     CSL_DmaxHandle           *hDmax;
 *           
 *     CSL_dmaxStartAsyncTransferMulti(hDmax);
 *    @endverbatim
 * 
 * ============================================================================
 */
extern CSL_Status CSL_dmaxStartAsyncTransferMulti(
    CSL_DmaxHandle *
);

/** =======================================================================
 *   @n@b CSL_dmaxGetHwSetupFifoXFRParamEntry
 *
 *   @b Description
 *   @n This function initializes the device registers with the appropriate
 *      values provided through the HwSetup Data structure. After the 
 *      Setup is completed, the device is ready for  operation.      
 *      For information passed through the HwSetup Data structure refer
 *   @a CSL_dmaxHwSetup.
 *
 *   @b Arguments
 *   @verbatim
 *    
 *          paramEntry  Pointer to Prameter Table Entry where data 
 *                          is to be stored
 *
 *          setup       Pointer to a dmax FIFO Transfer Setup Object
 *           
 *   @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK - Successful completion of hardware     
 *                                    setup
 *   @li                    CSL_ESYS_ INVPARAMS - Hardware structure is not 
 *                                    properly initialized
 *   @li                    CSL_ESYS_ BADHANDLE - Invalid CSL handle
 *
 *
 *   <b> Pre Condition </b>
 *   @n  Both CSL_dmaxInit() and a CSL_dmaxOpen() must be called
 *
 *   <b> Post Condition </b>
 *   @n  DMAX registers are configured 
 *
 *   @b  Modifies
 *   @n  DMAX registers
 *
 *   @b Example
 *   @verbatim  
      CSL_DmaxParameterEntry    paramEntry;
      CSL_dmaxHwSetup           hwSetup;
      
    hwSetup.linearReload0 = paramEntry[0];
    .
    .
    hwSetup.delayTabPtr1  = paramEntry[9];
    
      CSL_dmaxGetHwSetupFifoXFRParamEntry(hDmax, &hwSetup);
     @endverbatim
 * 
 * ============================================================================
 */
extern CSL_Status CSL_dmaxGetHwSetupFifoXFRParamEntry(
    CSL_DmaxParameterEntry *, 
    CSL_DmaxFifoParameterSetup *
);

/** =======================================================================
 *   @n@b CSL_dmaxGetHwSetupGenXFRParamEntry
 *
 *   @b Description
 *   @n This function formats the parameter table entry for a General Purpose
 *      transfer.
 *   @a CSL_dmaxHwSetup.
 *
 *   @b Arguments
 *   @verbatim
 *    
 *          paramEntry  Pointer to Prameter Table Entry where data 
 *                      is to be stored.
 *          cc          Counter configuration.
 *          setup       Pointer to a dmax General Purpose Transfer Object.
 *           
 *   @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK - Successful completion of hardware     
 *                                    setup
 *   @li                    CSL_ESYS_ INVPARAMS - Hardware structure is  
 *                                    not properly initialized
 *   @li                    CSL_ESYS_ BADHANDLE - Invalid CSL handle
 *
 *
 *   <b> Pre Condition </b>
 *   @n  Both CSL_dmaxInit() and a CSL_dmaxOpen() must be called
 *
 *   <b> Post Condition </b>
 *   @n  DMAX registers are configured 
 *
 *   @b  Modifies
 *   @n  DMAX registers
 *
 *   @b Example
 *   @verbatim  
 *    CSL_DmaxParameterEntry        paramEntry;
 *    Uint8                         cc;
 *    CSL_DmaxGPXFRParameterSetup   hwSetup;
 *     
 *  hwSetup.srcReloadAddr0  = paramEntry[0];
 *  .
 *  .
 *  hwSetup.dstReloadAddr0  = paramEntry[1];
 *  
 *    CSL_dmaxGetHwSetupGenXFRParamEntry(paramEntry, cc, &hwSetup);
 *   @endverbatim
 * 
 * ============================================================================
 */
extern CSL_Status CSL_dmaxGetHwSetupGenXFRParamEntry(
    CSL_DmaxParameterEntry *,
    Uint8 , 
    CSL_DmaxGPXFRParameterSetup *
);


/******************************************************************************
* FUNCTION NAME: _CSL_dmaxSetDetr                                            *
*                                                                            *
*   Regs Modified     : A0,B4,B5,SP                                          *
*   Regs Used         : A0,A4,B3,B4,B5,SP                                    *
*   Local Frame Size  : 0 Args + 4 Auto + 0 Save = 4 byte                    *
******************************************************************************
*/

extern Uint32 CSL_dmaxSetDetr(
    Uint32
);

/******************************************************************************
* FUNCTION NAME: _CSL_dmaxGetDesr                                            *
*                                                                            *
*   Regs Modified     : A4,B4                                                *
*   Regs Used         : A4,B3,B4                                             *
*   Local Frame Size  : 0 Args + 0 Auto + 0 Save = 0 byte                    *
******************************************************************************
*/
extern Uint32 CSL_dmaxGetDesr(
    void
);

/** =======================================================================
 *   @n@b CSL_dmaxSetupGeneralXFRParameterEntry
 *
 *   @b Description
 *   @n This function formats the parameter table entry for a General Purpose
 *      transfer.
 *   @a CSL_dmaxHwSetup.
 *
 *   @b Arguments
 *   @verbatim
 *    
 *          paramEntry  Pointer to Prameter Table Entry where data is 
 *                      to be stored.
 *          cc          Counter configuration.
 *          setup       Pointer to a dmax General Purpose Transfer Object.
 *           
 *   @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK - Successful completion of hardware     
 *                                    setup
 *   @li                    CSL_ESYS_ INVPARAMS - Hardware structure is not 
 *                                    properly initialized
 *   @li                    CSL_ESYS_ BADHANDLE - Invalid CSL handle
 *
 *
 *   <b> Pre Condition </b>
 *   @n  Both CSL_dmaxInit() and a CSL_dmaxOpen() must be called
 *
 *   <b> Post Condition </b>
 *   @n  DMAX registers are configured 
 *
 *   @b  Modifies
 *   @n  DMAX registers
 *
 *   @b Example
 *   @verbatim  
      CSL_DmaxParameterEntry        paramEntry;
      Uint8             cc;
      CSL_DmaxGPXFRParameterSetup   hwSetup;
      
      hwSetup.srcReloadAddr0  = 0x10000100;
      hwSetup.dstReloadAddr0  = 0x20000100;
      .
      .
      hwSetup.count0        = 3;
      hwSetup.count1        = 4;
      hwSetup.count2        = 2;
    
      CSL_dmaxHwSetupGenXFRParametryEntry (paramEntry, cc, &hwSetup);
     @endverbatim
 * 
 * ============================================================================
 */
extern CSL_Status CSL_dmaxSetupGeneralXFRParameterEntry(
    CSL_DmaxParameterEntry *,
    Uint8, 
    CSL_DmaxGPXFRParameterSetup *
);

/** =======================================================================
 *   @n@b CSL_dmaxHwSetupFifoParam
 *
 *   @b Description
 *   @n This function initializes the device registers with the appropriate
 *      values provided through the HwSetup Data structure. After the 
 *      Setup is completed, the device is ready for  operation.      
 *      For information passed through the HwSetup Data structure refer
 *   @a CSL_dmaxHwSetup.
 *
 *   @b Arguments
 *   @verbatim
 *    
 *          paramEntry  Pointer to Prameter Table Entry where data is to be 
 *                      stored
 *          setup       Pointer to a dmax FIFO Transfer Setup Object
 *           
 *   @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK - Successful completion of hardware     
 *                                    setup
 *   @li                    CSL_ESYS_ INVPARAMS - Hardware structure is not 
 *                                    properly initialized
 *   @li                    CSL_ESYS_ BADHANDLE - Invalid CSL handle
 *
 *
 *   <b> Pre Condition </b>
 *   @n  Both CSL_dmaxInit() and a CSL_dmaxOpen() must be called
 *
 *   <b> Post Condition </b>
 *   @n  DMAX registers are configured 
 *
 *   @b  Modifies
 *   @n  DMAX registers
 *
 *   @b Example
 *   @verbatim  
      CSL_DmaxParameterEntry    paramEntry;
      CSL_dmaxHwSetup           hwSetup;
      
      hwSetup.linearReload0  = 0x10000100;
      .
      .
      hwSetup.count0         = 3;
    
      CSL_dmaxHwSetupFifoXFRParameterEntry(hDmax, &hwSetup);
     @endverbatim
 * 
 * ============================================================================
 */
extern CSL_Status CSL_dmaxSetupFifoXFRParameterEntry(
    CSL_DmaxParameterEntry *, 
    CSL_DmaxFifoParameterSetup *
);
                                

/** ===========================================================================
* @func CSL_dmaxGetNextFreeParamEntry
 *
 *   @b Description
 *   @n Searchs for next free ParamEntry for given resource type
 *
 * 
 *       
 *   @b Arguments
 *   @verbatim
 *    
 *          uid         Pointer to Parameter Table Entry where data is stored
 *          st          Status
 *           
 *   @endverbatim
 *
 *   <b> Return Value </b> CSL_Status
 *   @li                   CSL_SOK - Found next free Parameter Entry.     
 *
 *   @li                   CSL_ESYS_OVFL - Next free Parameter Entry not found
 *
 *
 *   <b> Pre Condition </b>
 *   @n  Both CSL_dmaxInit() and a CSL_dmaxOpen() must be called
 *
 *   <b> Post Condition </b>
 *   @n  None 
 *
 *   @b  Modifies
 *   @n  None
 *
 *   @b Example
 *   @verbatim  
    
      CSL_dmaxGetNextFreeParameterEntry(hDmax->paramUid, &status);
     @endverbatim
 * 
 * ============================================================================
 */
extern Uint32 CSL_dmaxGetNextFreeParamEntry(
    Uint32 , 
    CSL_Status *
);

#ifdef __cplusplus
}
#endif


#endif /* _CSL_DMAX_H_ */