csl_edc.h

TI达芬奇dm644x各硬件模块测试代码

/** ===========================================================================
 *   @n@b CSL_edcEnable
 *
 *   @b Description
 *        Enables the EDC for the specified memory
 *
 *   @b Arguments
 *   @verbatim

        edcMem          Specificies what memory EDC is to be enabled

     @endverbatim
 *
*   <b> Return Value </b>  CSL_Status
 *                          CSL_SOK            - Always
 *
 *   @b Example
 *   @verbatim
 *        CSL_status        status;
 *        CSL_EdcMem        edcMem = CSL_EDC_L2;
 *
 *        status = CSL_edcEnable (edcMem);
 *  @endverbatim
 * ===========================================================================
 */
CSL_Status  CSL_edcEnable
(
    /** Specificies what memory EDC is to be enabled
     */
    CSL_EdcMem              edcMem
);

/**
@}
*/

/** ===========================================================================
 *   @n@b CSL_edcDisable
 *
 *   @b Description
 *        Disables the EDC for the specified memory
 *
 *   @b Arguments
 *   @verbatim

        edcMem          Specificies what memory EDC is to be disabled

     @endverbatim
 *
*   <b> Return Value </b>  CSL_Status
 *                          CSL_SOK            - Always
 *
 *   @b Example
 *   @verbatim
 *        CSL_status        status;
 *        CSL_EdcMem        edcMem = CSL_EDC_L2;
 *
 *        status = CSL_edcDisable (edcMem);
 *  @endverbatim
 * ===========================================================================
 */
CSL_Status  CSL_edcDisable
(
    /** Specificies what memory EDC is to be enabled
     */
    CSL_EdcMem              edcMem
);

/**
@}
*/

/** ===========================================================================
 *   @n@b CSL_edcClear
 *
 *   @b Description
 *        Clears the Address of the parity error for the specified memory
 *        along with the access type parity error bit
 *
 *   @b Arguments
 *   @verbatim

        edcMem          specificies what memory EDC is to be cleared

        edcAccessType   specificies what fetch type parity error bit is to be
                        cleared

     @endverbatim
 *
*   <b> Return Value </b>  CSL_Status
 *                          CSL_SOK            - Always
 *
 *   @b Example
 *   @verbatim
 *        CSL_status            status;
 *        CSL_EdcMem            edcMem = CSL_EDC_L2;
 *        CSL_EdcClrAccessType  edcAccessType = CSL_EDC_DCLR;

 *        status = CSL_edcClear (edcMem, edcAccessType);
 *  @endverbatim
 * ===========================================================================
 */
CSL_Status  CSL_edcClear
(
    /** Specificies what memory EDC error address is to be cleared
     */
    CSL_EdcMem              edcMem,
    /** Specificies what fetch type parity error bit is to be Cleared
     */
    CSL_EdcClrAccessType    edcAccessType
);

/**
@}
*/

/** ===========================================================================
 *   @n@b CSL_edcGetAddr
 *
 *   @b Description
 *        Used to get the Address location of the parity error.
 *
 *   @b Arguments
 *   @verbatim

        edcMem          specificies what memory EDC is to be cleared

        edcAddr         pointer to the structure for returning Address, L2 Way,
                        Qline, SRAM/Cache Info for error

     @endverbatim
 *
*   <b> Return Value </b>  CSL_Status
 *                          CSL_SOK            - Always
 *
 *   @b Example
 *   @verbatim
 *        CSL_status            status;
 *        CSL_EdcMem            edcMem = CSL_EDC_L2;
 *        CSL_EdcAddrInfo       edcAddr = CSL_EDC_DCLR;

 *        status = CSL_edcGetAddr (edcMem, &edcAddr);
 *  @endverbatim
 * ===========================================================================
 */
CSL_Status  CSL_edcGetAddr
(
    /** Specificies what memory EDC Address Info is to be aquired for
     */
    CSL_EdcMem              edcMem,
    /** Structure for returning Address, L2 Way, Qline, SRAM/Cache Info for error
     */
    CSL_EdcAddrInfo         *edcAddr
);
/**
@}
*/

/** ===========================================================================
 *   @n@b CSL_edcGetHwStatus
 *
 *   @b Description
 *        Gets the requested HW Status of the specified memory
 *
 *   @b Arguments
 *   @verbatim

        edcMem          specificies what memory EDC is to be cleared

        query           Statur query

        response        place holder for status

     @endverbatim
 *
*   <b> Return Value </b>  CSL_Status
 *                          CSL_SOK            - Always
 *
 *   @b Example
 *   @verbatim
 *        CSL_status                status;
 *        CSL_EdcMem                edcMem = CSL_EDC_L2;
 *        CSL_EdcHwStatusQuery      query = CSL_EDC_QUERY_ENABLESTAT;
          void                      *response;

 *        status = CSL_edcGetHwStatus (edcMem, query, response);
 *  @endverbatim
 * ===========================================================================
 */
CSL_Status  CSL_edcGetHwStatus
(
    /** Specificies what memory EDC status is to be obtained for
     */
    CSL_EdcMem              edcMem,
    /** The query to this API which indicates the status
     *  to be returned
     */
    CSL_EdcHwStatusQuery    query,
    /** Placeholder to return the status. @a void* casted
    */
    void                    *response
);

/**
@}
*/

/** ===========================================================================
 *   @n@b CSL_edcPageEnable
 *
 *   @b Description
 *        Used to enable the pages for EDC
 *
 *   @b Arguments
 *   @verbatim

        mask          Specifies what pages of the given map(s) are to be
                      enabled by setting the bit corresponding to the page to 1

        umap          Specificies which map(s) to apply mask to (MAP0, MAP1,
                      or BOTH)

     @endverbatim
 *
*   <b> Return Value </b>  CSL_Status
 *                          CSL_SOK            - Always
 *
 *   @b Example
 *   @verbatim
 *        Uint32                      mask;
 *        CSL_EdcUmap                 umap;
 *
 *        status = CSL_edcPageEnable (mask, umap);
 *  @endverbatim
 * ===========================================================================
 */
/**
@defgroup CSL_EDC_PAGE_ENABLE_API EDC Page Enable API
@ingroup CSL_EDC_FUNCTION
@brief Used to enable the pages for EDC.
@{*/
CSL_Status  CSL_edcPageEnable
(
    /** Specifies what pages of the given map(s) are to be enabled by setting the
    * bit corresponding to the page to 1
    */
    Uint32                      mask,
    /** Specificies which map(s) to apply mask to (MAP0, MAP1, or BOTH)
     */
    CSL_EdcUmap                 umap
);

/**
@}
*/

/**
@defgroup EXAMPLE Example Usage in an ISR
@ingroup CSL_EDC_API
@{
@code
In order to clarify on the usage of some of the CSL APIs, a skeleton is presented below

Example: Interrupt driven Low level Driver
Main routine
Void main(){
    CSL_EdcAddrInfo     *Addr;
    CSL_Status          stat;
    Uint32              *AllStat;

// Initialize system before making any module calls specific calls
    if(CSL_sysInit() == CSL_SOK){
        CSL_edcInit();
    }

// Enable EDC for L2 memory
    stat = CSL_edcEnable(CSL_EDC_L2);
    exit;

// EDC code to be placed in an ISR to Get Information when a failure occurs
    stat    CSL_edcGetHwStatus(L2, CSL_EDC_QUERY_ALLSTAT, AllStat)
    stat    CSL_edcGetAddr(L2, Addr);
    exit;

} // End of Main

@endcode
@}
*/

#ifdef __cplusplus
}
#endif

#endif