view src/cs/services/atp/atp_uart_api.c @ 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_api.c                                         */
/*                                                                              */
/*    Purpose:           This file contains the external functions related to   */
/*                       the ATP-UART interface.                                */
/*                                                                              */
/*    Note:              None.                                                  */
/*                                                                              */
/*    Revision History:                                                         */
/*       10/04/01        Pascal Pompei                                          */
/*                          - Create.                                           */
/*                                                                              */
/* (C) Copyright 2001 by Texas Instruments Incorporated, All Rights Reserved.   */
/*                                                                              */
/********************************************************************************/
#include "atp/atp_uart_i.h"
#include "rvm/rvm_use_id_list.h"


/********************************************************************************/
/*                                                                              */
/*    Function Name:     atp_uart_open_com_port                                 */
/*                                                                              */
/*    Purpose:           This function instructs the ATP-UART interface to open */
/*                       the COM port.                                          */
/*                                                                              */
/*    Input Parameters:                                                         */
/*       com_port           - Contains the COM port number.                     */
/*       baud_rate          - Contains the baud rate (in bits per second).      */
/*                                                                              */
/*    Output Parameters: None.                                                  */
/*                                                                              */
/*    Global Parameters: None.                                                  */
/*                                                                              */
/*    Note:              None.                                                  */
/*                                                                              */
/*    Revision History:                                                         */
/*       10/04/01        Pascal Pompei                                          */
/*                          - Create.                                           */
/*                                                                              */
/********************************************************************************/
T_ATP_UART_ERROR_CODES atp_uart_open_com_port (T_ATP_UART_COM_PORT   com_port,
											   T_ATP_UART_BAUD_RATE  baud_rate)
{
    /* Declare a local variable.                                                */
	T_ATP_UART_OPEN_COM_PORT  *open_com_port_p = NULL;

/******************** atp_uart_open_com_port function begins ********************/

	/* Allocate memory required to instruct the ATP-UART interface to open the  */
	/* COM port. If insufficient resources, then report an internal memory      */
	/* error and abort.                                                         */
	if (rvf_get_buf (gbl_atp_uart_ctrl_blk_p->mb_id, \
					 sizeof (T_ATP_UART_OPEN_COM_PORT), \
					 (T_RVF_BUFFER **) (&open_com_port_p)) == RVF_RED)
	{
		rvf_send_trace ("  ATP-UART (api). Insufficient resources ",
						41,
						NULL_PARAM,
						RV_TRACE_LEVEL_WARNING,
						ATP_USE_ID);
		return (RV_MEMORY_ERR);
	}

	/* Fill the 'ATP-UART Open COM Port' header up.                             */
	(open_com_port_p->os_header).msg_id        = ATP_UART_OPEN_COM_PORT;
	(open_com_port_p->os_header).src_addr_id   = RVF_INVALID_ADDR_ID;
	(open_com_port_p->os_header).callback_func = NULL;

	/* Fill the 'ATP-UART Open COM Port' payload up.                            */
	open_com_port_p->com_port  = com_port;
	open_com_port_p->baud_rate = baud_rate;

	/* Send the 'ATP-UART Open COM Port' notification to the ATP-UART           */
	/* interface.                                                               */
	return (rvf_send_msg (gbl_atp_uart_ctrl_blk_p->addr_id, \
						  open_com_port_p));

} /******************* End of atp_uart_open_com_port function *******************/


/********************************************************************************/
/*                                                                              */
/*    Function Name:     atp_uart_start_gsm                                     */
/*                                                                              */
/*    Purpose:           This function instructs the ATP-UART interface to      */
/*                       initiate using the GSM protocol stack.                 */
/*                                                                              */
/*    Input Parameters:  None.                                                  */
/*                                                                              */
/*    Output Parameters: None.                                                  */
/*                                                                              */
/*    Global Parameters: None.                                                  */
/*                                                                              */
/*    Note:              The GSM protocol stack is initialized by invoking the  */
/*                       following AT commands:                                 */
/*                          AT+CFUN=1 : Set Phone Functionality (Full),         */
/*                          AT+COPS=0 : Operator Selection.                     */
/*                                                                              */
/*    Revision History:                                                         */
/*       09/26/02        Pascal Pompei                                          */
/*                          - Create.                                           */
/*                                                                              */
/********************************************************************************/
T_ATP_UART_ERROR_CODES atp_uart_start_gsm (void)
{
    /* Declare a local variable.                                                */
	T_ATP_UART_START_GSM  *start_gsm_p = NULL;

/********************** atp_uart_start_gsm function begins **********************/

	/* Allocate memory required to instruct the ATP-UART interface to initiate  */
	/* using the GSM protocol stack. If insufficient resources, then report an  */
	/* internal memory error and abort.                                         */
	if (rvf_get_buf (gbl_atp_uart_ctrl_blk_p->mb_id, \
					 sizeof (T_ATP_UART_START_GSM), \
					 (T_RVF_BUFFER **) (&start_gsm_p)) == RVF_RED)
	{
		rvf_send_trace ("  ATP-UART (api). Insufficient resources ",
						41,
						NULL_PARAM,
						RV_TRACE_LEVEL_WARNING,
						ATP_USE_ID);
		return (RV_MEMORY_ERR);
	}

	/* Fill the 'ATP-UART Start GSM' header up.                                 */
	(start_gsm_p->os_header).msg_id        = ATP_UART_START_GSM;
	(start_gsm_p->os_header).src_addr_id   = RVF_INVALID_ADDR_ID;
	(start_gsm_p->os_header).callback_func = NULL;

	/* Send the 'ATP-UART Start GSM' notification to the ATP-UART interface.    */
	return (rvf_send_msg (gbl_atp_uart_ctrl_blk_p->addr_id, \
						  start_gsm_p));

} /********************* End of atp_uart_start_gsm function *********************/