csl_atagethwsetup.c

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

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005
 *
 *   Use of this software is controlled by the terms and conditions found in the
 *   license agreement under which this software has been supplied.
 *   ===========================================================================
 */

/** @file csl_ataGetHwSetup.c
 *
 *  @brief    File for functional layer of CSL API @a CSL_ataGetHwSetup()
 *
 *  Description
 *    - The @a CSL_ataHwGetSetup() function definition & it's associated
 *      functions
 *
 *  Path: \\(CSLPATH)\\ipmodules\\ata\\src
 *
 *  Date 2004/03/08
 *  Author RG Kiran
 */

/* =============================================================================
 *  Revision History
 *  ===============
 *  08-Oct-2004 kpn  Updated according to review comments
 *  24-Sep-2004 kpn  Updated according to CSL Upgradation guidelines
 *  ============================================================================
 */

#include <csl_ata.h>
#include <csl_ataAux.h>

/** ============================================================================
 *   @n@b CSL_ataGetHwSetup
 *
 *   @b Description
 *   @n Gets the current setup of ATA.
 *
 *   @b Arguments
 *   @verbatim
            hAta            Handle to the ATA instance

            setup           Pointer to setup structure which contains the
                            setup information of ATA.
     @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK             - Setup info load successful.
 *   @li                    CSL_ESYS_BADHANDLE  - Invalid handle
 *   @li                    CSL_ESYS_INVPARAMS  - Invalid parameter
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  The registers of the specified ATA instance will be setup.
 *
 *   @b Modifies
 *   @n Hardware registers of the specified ATA instance.
 *
 *   @b Example
 *   @verbatim
        CSL_AtaHandle       hAta;
        CSL_AtaHwSetup      setup;
        CSL_Status          status;

        status = CSL_ataGetHwSetup (hAta, &setup);
     @endverbatim
 *  ============================================================================
 */
#pragma CODE_SECTION (CSL_ataGetHwSetup, ".text:csl_section:ata");
CSL_Status CSL_ataGetHwSetup (
    CSL_AtaHandle               hAta,
    CSL_AtaHwSetup             *setup
)
{
    if (hAta == NULL) {
        return CSL_ESYS_BADHANDLE;
    }

    if (setup == NULL) {
        return CSL_ESYS_INVPARAMS;
    }

    if (setup->control != NULL) {
        CSL_ataGetHwSetupControl (hAta, setup->control);
    }

    if (setup->characteristics != NULL) {
        CSL_ataGetHwSetupCharacteristics (hAta, setup->characteristics);
    }

    if (setup->override != NULL) {
        CSL_ataGetHwSetupOverride (hAta, setup->override);
    }

    if (setup->resetControl != NULL) {
        CSL_ataGetHwSetupResetControl (hAta, setup->resetControl);
    }

    if (setup->dma != NULL) {
        CSL_ataGetHwSetupDma (hAta, setup->dma);
    }

    if (setup->misc != NULL) {
        CSL_ataGetHwSetupMisc (hAta, setup->misc);
    }

    return CSL_SOK;
}