FreeCalypso > hg > fc-magnetite
view src/cs/drivers/drv_app/spi/spi_api.h @ 600:8f50b202e81f
board preprocessor conditionals: prep for more FC hw in the future
This change eliminates the CONFIG_TARGET_FCDEV3B preprocessor symbol and
all preprocessor conditionals throughout the code base that tested for it,
replacing them with CONFIG_TARGET_FCFAM or CONFIG_TARGET_FCMODEM. These
new symbols are specified as follows:
CONFIG_TARGET_FCFAM is intended to cover all hardware designs created by
Mother Mychaela under the FreeCalypso trademark. This family will include
modem products (repackagings of the FCDEV3B, possibly with RFFE or even
RF transceiver changes), and also my desired FreeCalypso handset product.
CONFIG_TARGET_FCMODEM is intended to cover all FreeCalypso modem products
(which will be firmware-compatible with the FCDEV3B if they use TI Rita
transceiver, or will require a different fw build if we switch to one of
Silabs Aero transceivers), but not the handset product. Right now this
CONFIG_TARGET_FCMODEM preprocessor symbol is used to conditionalize
everything dealing with MCSI.
At the present moment the future of FC hardware evolution is still unknown:
it is not known whether we will ever have any beyond-FCDEV3B hardware at all
(contingent on uncertain funding), and if we do produce further FC hardware
designs, it is not known whether they will retain the same FIC modem core
(triband), if we are going to have a quadband design that still retains the
classic Rita transceiver, or if we are going to switch to Silabs Aero II
or some other transceiver. If we produce a quadband modem that still uses
Rita, it will run exactly the same fw as the FCDEV3B thanks to the way we
define TSPACT signals for the RF_FAM=12 && CONFIG_TARGET_FCFAM combination,
and the current fcdev3b build target will be renamed to fcmodem. OTOH, if
that putative quadband modem will be Aero-based, then it will require a
different fw build target, the fcdev3b target will stay as it is, and the
two targets will both define CONFIG_TARGET_FCFAM and CONFIG_TARGET_FCMODEM,
but will have different RF_FAM numbers. But no matter which way we are
going to evolve, it is not right to have conditionals on CONFIG_TARGET_FCDEV3B
in places like ACI, and the present change clears the way for future
evolution.
| author | Mychaela Falconia <falcon@freecalypso.org> |
|---|---|
| date | Mon, 01 Apr 2019 01:05:24 +0000 |
| parents | 945cf7f506b2 |
| children |
line wrap: on
line source
/****************************************************************************/ /* */ /* File Name: spi_api.h */ /* */ /* Purpose: This file contains data structures and functions prototypes */ /* used to send events to the SPI SWE. */ /* */ /* Version 0.1 */ /* */ /* Date Modification */ /* ------------------------------------ */ /* 20/08/2000 Create */ /* */ /* Author */ /* */ /* (C) Copyright 2000 by Texas Instruments Incorporated, All Rights Reserved*/ /****************************************************************************/ #ifndef __SPI_API_H_ #define __SPI_API_H_ #include "rv/rv_general.h" #include "abb/abb.h" #ifdef __cplusplus extern "C" { #endif /* the message offset must differ for each SWE in order to have unique msg_id in the system */ #define SPI_MESSAGES_OFFSET (0x34 << 10) /* define a first msg id */ #define SPI_MESSAGE_1 (SPI_MESSAGES_OFFSET | 0x0001) typedef void (*CALLBACK_FUNC_NO_PARAM)(void); typedef void (*CALLBACK_FUNC_U16)(UINT16 *); /*****************************************/ /* structures of messages send to SPI */ /*****************************************/ typedef struct { T_RV_HDR os_hdr; UINT16 page; UINT16 address; UINT16 data; } T_SPI_WRITE; typedef struct { T_RV_HDR os_hdr; UINT16 page; UINT16 address; } T_SPI_READ; typedef struct { T_RV_HDR os_hdr; UINT16 channels; UINT16 itval; } T_SPI_ABB_CONF_ADC; typedef struct { T_RV_HDR os_hdr; UINT16 *Buff; CALLBACK_FUNC_NO_PARAM callback_func; } T_SPI_ABB_READ_ADC; #ifdef __cplusplus } #endif /* Prototypes */ /********************************************************************************/ /* */ /* Function Name: spi_abb_write */ /* */ /* Purpose: This function is used to send to the SPI mailbox a */ /* WRITE REGISTER rqst msg. */ /* */ /* Input Parameters: */ /* - page : ABB Page where to read the register. */ /* - address : address of the ABB register to read. */ /* - data : data to write in the ABB register */ /* */ /* Return : */ /* - RVM_NOT_READY : the SPI task is not ready */ /* - RV_MEMORY_ERR : the SPI task has not enough memory */ /* - RV_OK : normal processing */ /* */ /* Note: */ /* None. */ /* */ /********************************************************************************/ T_RV_RET spi_abb_write(UINT16 page, UINT16 address, UINT16 data); /********************************************************************************/ /* */ /* Function Name: spi_abb_read */ /* */ /* Purpose: This function is used to send a READ REGISTER rqst msg */ /* to the SPI mailbox. */ /* */ /* Input Parameters: */ /* - page : ABB Page where to read the register. */ /* - address : address of the ABB register to read. */ /* - CallBack : callback function called by the spi task */ /* at the end of the read process. */ /* */ /* Return : */ /* - RVM_NOT_READY : the SPI task is not ready */ /* - RV_MEMORY_ERR : the SPI task has not enough memory */ /* - RV_OK : normal processing */ /* */ /* Note: */ /* None. */ /* */ /********************************************************************************/ T_RV_RET spi_abb_read(UINT16 page, UINT16 address, CALLBACK_FUNC_U16 CallBack); /********************************************************************************/ /* */ /* Function Name: spi_abb_conf_ADC */ /* */ /* Purpose: This function is used to send to the SPI mailbox a rqst msg */ /* for configuring ABB MADC for conversions. */ /* */ /* Input Parameters: */ /* - channels : ABB channels to be converted. */ /* - itval : configure the End Of Conversion IT. */ /* */ /* Return : */ /* - RVM_NOT_READY : the SPI task is not ready */ /* - RV_MEMORY_ERR : the SPI task has not enough memory */ /* - RV_OK : normal processing */ /* */ /* Note: */ /* None. */ /* */ /********************************************************************************/ T_RV_RET spi_abb_conf_ADC(UINT16 channels, UINT16 itval); /********************************************************************************/ /* */ /* Function Name: spi_abb_read_ADC */ /* */ /* Purpose: This function is used to send to the SPI mailbox a rqst msg */ /* for reading the ABB ADC results. */ /* */ /* Input Parameters: */ /* - Buff : pointer to the buffer filled with ADC results. */ /* - CallBack : callback function called by the spi task */ /* at the end of the read process. */ /* */ /* Return : */ /* - RVM_NOT_READY : the SPI task is not ready */ /* - RV_MEMORY_ERR : the SPI task has not enough memory */ /* - RV_OK : normal processing */ /* */ /* Note: */ /* None. */ /* */ /********************************************************************************/ T_RV_RET spi_abb_read_ADC(UINT16 *Buff, CALLBACK_FUNC_NO_PARAM CallBack); #endif /* __SPI_API_H_ */