view src/cs/services/atp/atp_uart_env.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:         atp_uart_env.h                                         */
/*                                                                              */
/*    Purpose:           This header file contains the prototypes used to:      */
/*                          - get some information about the ATP-UART           */
/*                            interface, such as its name or the memory         */
/*                            requirements,                                     */
/*                          - set the memory bank identifier dedicated to the   */
/*                            ATP-UART interface,                               */
/*                          - initialize the ATP-UART interface,                */
/*                          - activate the ATP-UART interface,                  */
/*                          - prepare the termination of the ATP-UART           */
/*                            interface,                                        */
/*                          - kill the ATP-UART interface.                      */
/*                                                                              */
/*    Note:              None.                                                  */
/*                                                                              */
/*    Revision History:                                                         */
/*       10/04/01        Pascal Pompei                                          */
/*                          - Create.                                           */
/*                                                                              */
/* (C) Copyright 2001 by Texas Instruments Incorporated, All Rights Reserved.   */
/*                                                                              */
/********************************************************************************/
#ifndef _ATP_UART_ENV_
#define _ATP_UART_ENV_

#include "atp/atp_pool_size.h"	/* Stack & Memory Bank sizes definitions */

/****************************** MEMORY REQUIREMENTS *****************************/
/*                                                                              */
/* Define the memory requirements of the ATP-UART interface.                    */
#define ATP_UART_MB_PRIM_SIZE          ATP_UART_MB1_SIZE
#define ATP_UART_MB_PRIM_WATERMARK     (ATP_UART_MB_PRIM_SIZE - 256)


/*************************** LOCAL FUNCTION PROTOTYPES **************************/
/*                                                                              */
/* Define the local fonction prototypes.                                        */
T_RVM_RETURN atp_uart_get_info (T_RVM_INFO_SWE  *info_software_entity_p);

T_RVM_RETURN atp_uart_set_info (T_RVF_ADDR_ID  addr_id,
								T_RV_RETURN    return_path_p[],
								T_RVF_MB_ID    *mb_id_p,
								T_RVM_CB_FUNC  error_function_p);

T_RVM_RETURN atp_uart_init (void);

T_RVM_RETURN atp_uart_core (void);

T_RVM_RETURN atp_uart_stop (void);

T_RVM_RETURN atp_uart_kill (void);
#endif