Delta / NNN50_WIFI_API

Dependents:   NNN50_CE_Test_UDP NNN50_linux_firmware NNN50_SoftAP_HelloWorld NNN50_BLEWIFISensor ... more

Embed: (wiki syntax)

« Back to documentation index

m2m_ate_mode.c File Reference

m2m_ate_mode.c File Reference

NMC1500 Peripherials Application Interface. More...

Go to the source code of this file.

Functions

sint8 m2m_ate_init (void)
 This function used to download ATE firmware from flash and start it.
sint8 m2m_ate_deinit (void)
 De-Initialization of ATE firmware mode.
sint8 m2m_ate_set_fw_state (uint8 u8State)
 This function used to change ATE firmware status from running to stopped or vice versa.
uint32 m2m_ate_get_tx_rate (uint8 u8Index)
 This function used to return value of TX rate required by application developer.
sint8 m2m_ate_get_tx_status (void)
 This function used to return status of TX test case either running or stopped.
sint8 m2m_ate_start_tx (tstrM2mAteTx *strM2mAteTx)
 This function used to start TX test case.
sint8 m2m_ate_stop_tx (void)
 This function used to stop TX test case.
sint8 m2m_ate_start_rx (tstrM2mAteRx *strM2mAteRxStr)
 This function used to start RX test case.
sint8 m2m_ate_stop_rx (void)
 This function used to stop RX test case.
sint8 m2m_ate_read_rx_status (tstrM2mAteRxStatus *strM2mAteRxStatus)
 This function used to read RX statistics from ATE firmware.
sint8 m2m_ate_set_dig_gain (double dGaindB)
 This function is used to set the digital gain.
sint8 m2m_ate_get_dig_gain (double *dGaindB)
 This function is used to get the digital gain.
void m2m_ate_set_pa_gain (uint8 gain_db)
 This function is used to set the PA gain (18/15/12/9/6/3/0 only)
sint8 m2m_ate_get_pa_gain (double *paGaindB)
 This function is used to get the PA gain.
sint8 m2m_ate_get_ppa_gain (double *ppaGaindB)
 This function is used to get the PPA gain.
sint8 m2m_ate_get_tot_gain (double *totGaindB)
 This function is used to calculate the total gain.

Variables

static volatile uint8 gu8AteIsRunning = 0
static volatile uint8 gu8RxState = 0
static volatile uint8 gu8TxState = 0

Detailed Description

NMC1500 Peripherials Application Interface.

Copyright (c) 2016-2017 Atmel Corporation. All rights reserved.

Definition in file m2m_ate_mode.c.


Function Documentation

sint8 m2m_ate_deinit ( void   )

De-Initialization of ATE firmware mode.

Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 173 of file m2m_ate_mode.c.

sint8 m2m_ate_get_dig_gain ( double *  dGaindB )

This function is used to get the digital gain.

Parameters:
[out]double* dGaindB The retrieved digital gain value obtained from HW registers in dB.
Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 664 of file m2m_ate_mode.c.

sint8 m2m_ate_get_pa_gain ( double *  paGaindB )

This function is used to get the PA gain.

Parameters:
[out]double*paGaindB The retrieved PA gain value obtained from HW registers in dB.
Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 718 of file m2m_ate_mode.c.

sint8 m2m_ate_get_ppa_gain ( double *  ppaGaindB )

This function is used to get the PPA gain.

Parameters:
[out]uint32* ppaGaindB The retrieved PPA gain value obtained from HW registers in dB.
Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 770 of file m2m_ate_mode.c.

sint8 m2m_ate_get_tot_gain ( double *  totGaindB )

This function is used to calculate the total gain.

Parameters:
[out]double* totGaindB The retrieved total gain value obtained from calculations made based on the digital gain, PA and PPA gain values.
Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 812 of file m2m_ate_mode.c.

uint32 m2m_ate_get_tx_rate ( uint8  u8Index )

This function used to return value of TX rate required by application developer.

Parameters:
[in]u8IndexIndex of required rate , one of tenuM2mAteTxIndexOfRates enumeration values.
Returns:
The function SHALL return 0 for in case of failure otherwise selected rate value.
See also:
tenuM2mAteTxIndexOfRates

Definition at line 289 of file m2m_ate_mode.c.

sint8 m2m_ate_get_tx_status ( void   )

This function used to return status of TX test case either running or stopped.

Returns:
The function SHALL return status of ATE firmware, 1 if TX is running otherwise 0.
See also:
m2m_ate_start_tx, m2m_ate_stop_tx

Definition at line 310 of file m2m_ate_mode.c.

sint8 m2m_ate_init ( void   )

This function used to download ATE firmware from flash and start it.

Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 134 of file m2m_ate_mode.c.

sint8 m2m_ate_read_rx_status ( tstrM2mAteRxStatus strM2mAteRxStatus )

This function used to read RX statistics from ATE firmware.

Parameters:
[out]strM2mAteRxStatusType of tstrM2mAteRxStatus used to save statistics of RX test case. You must use m2m_ate_start_rx first.
Returns:
The function SHALL return 0 for success and a negative value otherwise.
See also:
m2m_ate_init, m2m_ate_start_rx

Definition at line 597 of file m2m_ate_mode.c.

sint8 m2m_ate_set_dig_gain ( double  dGaindB )

This function is used to set the digital gain.

Parameters:
[in]doubledGaindB The digital gain value required to be set.
Returns:
The function SHALL return 0 for success and a negative value otherwise.

Definition at line 641 of file m2m_ate_mode.c.

sint8 m2m_ate_set_fw_state ( uint8  u8State )

This function used to change ATE firmware status from running to stopped or vice versa.

Parameters:
[in]u8StateRequired state of ATE firmware, one of tenuM2mAteFwState enumeration values.
Returns:
The function SHALL return 0 for success and a negative value otherwise.
See also:
m2m_ate_init

Write the firmware download complete magic value 0x10ADD09E at location 0xFFFF000C (Cortus map) or C000C (AHB map). This will let the boot-rom code execute from RAM.

Definition at line 192 of file m2m_ate_mode.c.

void m2m_ate_set_pa_gain ( uint8  gain_db )

This function is used to set the PA gain (18/15/12/9/6/3/0 only)

Parameters:
[in]uint8gain_db PA gain level allowed (18/15/12/9/6/3/0 only)

Definition at line 688 of file m2m_ate_mode.c.

sint8 m2m_ate_start_rx ( tstrM2mAteRx strM2mAteRxStr )

This function used to start RX test case.

Parameters:
[in]strM2mAteRxType of tstrM2mAteRx, with the values required to enable RX test case. You must use m2m_ate_init first.
Returns:
The function SHALL return 0 for success and a negative value otherwise.
See also:
m2m_ate_init, m2m_ate_stop_rx, m2m_ate_get_rx_status

Definition at line 487 of file m2m_ate_mode.c.

sint8 m2m_ate_start_tx ( tstrM2mAteTx strM2mAteTx )

This function used to start TX test case.

Parameters:
[in]strM2mAteTxType of tstrM2mAteTx, with the values required to enable TX test case. You must use m2m_ate_init first.
Returns:
The function SHALL return 0 for success and a negative value otherwise.
See also:
m2m_ate_init, m2m_ate_stop_tx, m2m_ate_get_tx_status

Definition at line 329 of file m2m_ate_mode.c.

sint8 m2m_ate_stop_rx ( void   )

This function used to stop RX test case.

Returns:
The function SHALL return 0 for success and a negative value otherwise.
See also:
m2m_ate_init, m2m_ate_start_rx, m2m_ate_get_rx_status

Definition at line 576 of file m2m_ate_mode.c.

sint8 m2m_ate_stop_tx ( void   )

This function used to stop TX test case.

Returns:
The function SHALL return 0 for success and a negative value otherwise.
See also:
m2m_ate_init, m2m_ate_start_tx, m2m_ate_get_tx_status

Definition at line 443 of file m2m_ate_mode.c.


Variable Documentation

volatile uint8 gu8AteIsRunning = 0 [static]

ATE firmware status, 1 means ATE is running otherwise stopped

Definition at line 98 of file m2m_ate_mode.c.

volatile uint8 gu8RxState = 0 [static]

RX status, 1 means Rx is running otherwise stopped

Definition at line 99 of file m2m_ate_mode.c.

volatile uint8 gu8TxState = 0 [static]

TX status, 1 means Tx is running otherwise stopped

Definition at line 100 of file m2m_ate_mode.c.