Functions
csl_aif2Reset.c File Reference

Antenna Interface 2 reset CSL 3.x function. More...

#include <ti/csl/csl_aif2.h>

Functions

CSL_Status CSL_aif2Reset (CSL_Aif2Handle pAif2Handle)
 Reset whole AIF2 module.

Detailed Description

Antenna Interface 2 reset CSL 3.x function.

===========================================================================


Function Documentation

CSL_Status CSL_aif2Reset ( CSL_Aif2Handle  pAif2Handle)

Reset whole AIF2 module.

============================================================================
CSL_aif2Reset Description
Reset whole AIF2 devices and MMRs The handle returned by this call is input as an essential argument for rest of the APIs described for this module.

Arguments

           pAif2Handle    Pointer to the object that holds reference to the
                          instance of AIF2 requested after the call

     

Return Value CSL_Status Valid AIF2 status will be returned if status value is equal to CSL_SOK.

Pre Condition
AIF2 must be successfully initialized via CSL_AIF2Init(), CSL_AIF2Open() before calling this function. Memory for the CSL_Aif2Obj must be allocated outside this call. This object must be retained while usage of this peripheral.

Post Condition
1. The status is returned in the status variable. If status returned is

  • CSL_SOK Valid AIF2 handle is returned
  • CSL_ESYS_FAIL The AIF2 instance is invalid

Writes
AIF2_AIF2_RESET_SW_RST

Example:

          //aif2  handle
          CSL_Aif2Handle hAif2;
         
          // CSL status
          CSL_Status status;
   
          //Reset handle  - for use 
          status = CSL_aif2Reset(hAif2);

          if (status != CSL_SOK) 
          {
             printf ("\nError resetting CSL_AIF2");
             exit(1);
          }
       

===========================================================================

Parameters:
pAif2HandlePointer to the object that holds reference to the instance of AIF2 requested after the call

Copyright 2014, Texas Instruments Incorporated