Functions
csl_aif2GetHwStatus.c File Reference

Antenna Interface 2 get hardware status function. More...

#include <ti/csl/csl_aif2.h>
#include <ti/csl/csl_aif2GetHwStatusAux.h>

Functions

CSL_Status CSL_aif2GetHwStatus (CSL_Aif2Handle hAif2, CSL_Aif2HwStatusQuery Query, void *response)

Detailed Description

Antenna Interface 2 get hardware status function.

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


Function Documentation

CSL_Status CSL_aif2GetHwStatus ( CSL_Aif2Handle  hAif2,
CSL_Aif2HwStatusQuery  Query,
void *  response 
)

============================================================================
CSL_aif2GetHwStatus

Description
This function is used to get the value of various parameters of the aif2 instance. The value returned depends on the query passed.

Arguments

            hAif2      Handle to the aif2 instance
 
            Query         Query to be performed 
 
            response      Pointer to buffer to return the data requested by
                          the query passed
     

Return Value CSL_Status

  • CSL_SOK - Successful completion of the query
  • CSL_ESYS_BADHANDLE - Invalid handle
  • CSL_ESYS_INVQUERY - Query command not supported
  • CSL_ESYS_FAIL - Generic failure

Pre Condition
CSL_aif2Init(), CSL_aif2Open()

Post Condition Data requested by query is returned through the variable "response"

Writes
The input argument "response" is modified

Example

        
        #define CSL_AIF2_MAX_RX_MASTER_FRAME_OFFSET 		256   
 
        CSL_Aif2Handle hAif2;
        // other link related declarations
        ...
        // ctrl argument for hw command
        Bool ctrlArg;
        // query response
        Uint16 response;

        // Open handle  - for use 
        hAif2 = CSL_aif2Open(&Aif2Obj, CSL_AIF2, &aif2Param, &status);

        if ((hAif2 == NULL) || (status != CSL_SOK)) 
        {
           printf ("\nError opening CSL_AIF2");
           exit(1);
        }

        // Do config for link 0 
        Config.globalSetup = &gblCfg;
        ...
         
        //Do setup for link - 0
        CSL_aif2HwSetup(hAif2, &Config);

        ctrlArg = CSL_AIF2_CTRL_RX_LINK_ENABLE;
        hAif2->arg_link = CSL_AIF2_LINK_0; //link 0 enable
        
        // Send hw control command to enable Tx/Rx of link 0 
        CSL_aif2HwControl(hAif2, CSL_AIF2_CMD_ENABLE_DISABLE_RX_LINK, (void *)&ctrlArg);
        ...
        wait(100); //wait for a sufficient length of time, so Rx link has enough 
                     time to sync; 100 cycles wait time is arbitrarily chosen 
    
        // Get status of Rx master frame offset  
        hAif2->arg_link = CSL_AIF2_LINK_0; //get link 0 status
        CSL_aif2GetHwStatus(hAif2, CSL_AIF2_QUERY_RM_LINK_RCVD_MSTR_FRAME_OFFSET, (void *)&response);
   
        if (response > CSL_AIF2_MAX_RX_MASTER_FRAME_OFFSET)
        {
           printf("\nRx Master Frame Offset exceeds bounds");
        }

     

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

returns VC AIF2 version

returns VC Emu status

RM link Status 0. use hAif2->arg_link to choose link.

Parameters:
(CSL_Aif2RmStatus0*)

RM link Status 1. use hAif2->arg_link to choose link.

Parameters:
(CSL_Aif2RmStatus1*)

RM link Status 2. use hAif2->arg_link to choose link.

Parameters:
(CSL_Aif2RmStatus2*)

RM link Status 3. use hAif2->arg_link to choose link.

Parameters:
(CSL_Aif2RmStatus3*)

RM link Status 4. use hAif2->arg_link to choose link.

Parameters:
(CSL_Aif2RmStatus4*)

Return TM link CPRI HFN Status. use hAif2->arg_link to choose link.

Parameters:
(Uint8*)

TM link Status. use hAif2->arg_link to choose link.

Parameters:
(CSL_Aif2TmStatus*)

RT Internal FIFO depth Status. use hAif2->arg_link to choose link.

Parameters:
(Uint8*)

RT Header Error Status. use hAif2->arg_link to choose link.

Parameters:
(CSL_Aif2RtHeaderStatus*)

RT link Status. use hAif2->arg_link to choose link.

Parameters:
(CSL_Aif2RtStatus*)

PD 128 Channel Status.

Parameters:
(Uint32*)

PD Packet Status for 128 channels if it is in or out of packet.

Parameters:
(Uint32*)

PE 128 Channel Status.

Parameters:
(Uint32*)

PE Packet Status for 128 channels if it is in or out of packet.

Parameters:
(Uint32*)

Debug data written to bits 128:0 of Egress DB RAM

Parameters:
(Uint32 *)

Egress DB debug side band data setup

Parameters:
(CSL_Aif2DbSideData *)

Copyright 2014, Texas Instruments Incorporated