Diego Ostuni / RFAL

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

AnalogConfig
Data Structures | Typedefs | Functions

AnalogConfig
[RFAL-HAL]

RFAL Analog Config Module. More...

Data Structures

struct  rfalAnalogConfigRegAddrMaskVal
struct  rfalAnalogConfig

Typedefs

typedef uint8_t rfalAnalogConfigMode
typedef uint8_t rfalAnalogConfigTech
typedef uint8_t rfalAnalogConfigBitrate
typedef uint8_t rfalAnalogConfigDirection
typedef uint8_t rfalAnalogConfigRegAddr [2]
typedef uint8_t rfalAnalogConfigRegMask
typedef uint8_t rfalAnalogConfigRegVal
typedef uint16_t rfalAnalogConfigId
typedef uint16_t rfalAnalogConfigOffset
typedef uint8_t rfalAnalogConfigNum

Functions

void rfalAnalogConfigInitialize (void)
 Initialize the Analog Configuration.
bool rfalAnalogConfigIsReady (void)
 Indicate if the current Analog Configuration Table is complete and ready to be used.
ReturnCode rfalAnalogConfigListWriteRaw (const uint8_t *configTbl, uint16_t configTblSize)
 Write the whole Analog Configuration table in raw format.
ReturnCode rfalAnalogConfigListWrite (uint8_t more, rfalAnalogConfig *config)
 Write the Analog Configuration table with new analog settings.
ReturnCode rfalAnalogConfigListReadRaw (uint8_t *tblBuf, uint16_t tblBufLen, uint16_t *configTblSize)
 Read the whole Analog Configuration table in raw format.
ReturnCode rfalAnalogConfigListRead (rfalAnalogConfigOffset *configOffset, uint8_t *more, rfalAnalogConfig *config, rfalAnalogConfigNum numConfig)
 Read the Analog Configuration table.
ReturnCode rfalSetAnalogConfig (rfalAnalogConfigId configId, SPI *mspiChannel, ST25R3911 *mST25, DigitalOut *gpio_cs, InterruptIn *IRQ, DigitalOut *fieldLED_01, DigitalOut *fieldLED_02, DigitalOut *fieldLED_03, DigitalOut *fieldLED_04, DigitalOut *fieldLED_05, DigitalOut *fieldLED_06)
 Set the Analog settings of indicated Configuration ID.

Detailed Description

RFAL Analog Config Module.

Typedef Documentation

typedef uint8_t rfalAnalogConfigBitrate

Bitrate of Configuration

Definition at line 161 of file rfal_AnalogConfig.h.

typedef uint8_t rfalAnalogConfigDirection

Transmit/Receive direction of Configuration

Definition at line 162 of file rfal_AnalogConfig.h.

typedef uint16_t rfalAnalogConfigId

Analog Configuration ID

Definition at line 168 of file rfal_AnalogConfig.h.

typedef uint8_t rfalAnalogConfigMode

Polling or Listening Mode of Configuration

Definition at line 159 of file rfal_AnalogConfig.h.

typedef uint8_t rfalAnalogConfigNum

Number of Analog settings for the respective Configuration ID

Definition at line 170 of file rfal_AnalogConfig.h.

typedef uint16_t rfalAnalogConfigOffset

Analog Configuration offset address in the table

Definition at line 169 of file rfal_AnalogConfig.h.

typedef uint8_t rfalAnalogConfigRegAddr[2]

Register Address to ST Chip

Definition at line 164 of file rfal_AnalogConfig.h.

typedef uint8_t rfalAnalogConfigRegMask

Register Mask Value

Definition at line 165 of file rfal_AnalogConfig.h.

typedef uint8_t rfalAnalogConfigRegVal

Register Value

Definition at line 166 of file rfal_AnalogConfig.h.

typedef uint8_t rfalAnalogConfigTech

Technology of Configuration

Definition at line 160 of file rfal_AnalogConfig.h.

Function Documentation

void rfalAnalogConfigInitialize ( void   )

Initialize the Analog Configuration.

Reset the Analog Configuration LUT pointer to reference to default settings.

Definition at line 112 of file rfal_analogConfig.cpp.

bool rfalAnalogConfigIsReady ( void   )

Indicate if the current Analog Configuration Table is complete and ready to be used.

Returns:
true if current Analog Configuration Table is complete and ready to be used.
false if current Analog Configuration Table is incomplete

Definition at line 122 of file rfal_analogConfig.cpp.

ReturnCode rfalAnalogConfigListRead ( rfalAnalogConfigOffset *  configOffset,
uint8_t *  more,
rfalAnalogConfig *  config,
rfalAnalogConfigNum  numConfig 
)

Read the Analog Configuration table.

Read the Analog Configuration Table

Parameters:
[in]configOffset,:offset to the next Configuration ID in the List Table to be read.
[out]more,:0x00 indicates it is last Configuration ID settings; 0x01 indicates more Configuration ID setting(s) are coming.
[out]config,:configuration id, number of configuration sets and register-mask-value sets
[in]numConfig,:the remaining configuration settings space available;
Returns:
ERR_NOMEM : if number of Configuration for respective Configuration ID is greater the the remaining configuration setting space available
ERR_NONE : if read is successful

Definition at line 245 of file rfal_analogConfig.cpp.

ReturnCode rfalAnalogConfigListReadRaw ( uint8_t *  tblBuf,
uint16_t  tblBufLen,
uint16_t *  configTblSize 
)

Read the whole Analog Configuration table in raw format.

Reads the whole Analog Configuration Table in raw format

Parameters:
[out]tblBuf,:location to the buffer to place the Config Table
[in]tblBufLen,:length of the buffer to place the Config Table
[out]configTblSize,:Config Table size
Returns:
ERR_PARAM : if configTbl or configTblSize is invalid
ERR_NOMEM : if configTblSize is not enough for the whole table
ERR_NONE : if read is successful

Definition at line 224 of file rfal_analogConfig.cpp.

ReturnCode rfalAnalogConfigListWrite ( uint8_t  more,
rfalAnalogConfig *  config 
)

Write the Analog Configuration table with new analog settings.

Writes the Analog Configuration and Look Up Table with the new list of register-mask-value and Configuration ID respectively.

NOTE: Function does not check for the validity of the Register Address.

Parameters:
[in]more,:0x00 indicates it is last Configuration ID settings; 0x01 indicates more Configuration ID setting(s) are coming.
[in]*config,:reference to the configuration list of current Configuraiton ID.
Returns:
ERR_PARAM : if Configuration ID or parameter is invalid
ERR_NOMEM : if LUT is full
ERR_REQUEST : if the update Configuration Id is disabled
ERR_NONE : if setting is updated

Definition at line 163 of file rfal_analogConfig.cpp.

ReturnCode rfalAnalogConfigListWriteRaw ( const uint8_t *  configTbl,
uint16_t  configTblSize 
)

Write the whole Analog Configuration table in raw format.

Writes the Analog Configuration and Look Up Table with the given raw table

NOTE: Function does not check the validity of the given Table contents

Parameters:
[in]configTbl,:location of config Table to be loaded
[in]configTblSize,:size of the config Table to be loaded
Returns:
ERR_NONE : if setting is updated
ERR_PARAM : if configTbl is invalid
ERR_NOMEM : if the given Table is bigger exceeds the max size
ERR_REQUEST : if the update Configuration Id is disabled

Definition at line 127 of file rfal_analogConfig.cpp.

ReturnCode rfalSetAnalogConfig ( rfalAnalogConfigId  configId,
SPI *  mspiChannel,
ST25R3911 *  mST25,
DigitalOut *  gpio_cs,
InterruptIn *  IRQ,
DigitalOut *  fieldLED_01,
DigitalOut *  fieldLED_02,
DigitalOut *  fieldLED_03,
DigitalOut *  fieldLED_04,
DigitalOut *  fieldLED_05,
DigitalOut *  fieldLED_06 
)

Set the Analog settings of indicated Configuration ID.

Update the chip with indicated analog settings of indicated Configuration ID.

Parameters:
[in]configId,:configuration ID
Returns:
ERR_PARAM if Configuration ID is invalid
ERR_INTERNAL if error updating setting to chip
ERR_NONE if new settings is applied to chip

Definition at line 275 of file rfal_analogConfig.cpp.

Generated on Fri Jul 15 2022 06:42:12 by  doxygen 1.7.2