FreeCalypso > hg > fc-magnetite

view src/cs/services/atp/atp_gsm_bt_api.h @ 600:8f50b202e81f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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_gsm_bt_api.h
 *
 * Definition used by atp_gsm_bt_api.c
 *
 * (C) Texas Instruments, all rights reserved
 *
 * Version number	: 0.1      Date : 10-Jully-2000
 *
 * History			: 0.1  - Created by E. Baissus
 *
 *
 * Author           : Eric Baissus : e-baissus@ti.com
 *
 ******************************************************************************/

#ifndef ATP_GSM_BT_API_H
#define ATP_GSM_BT_API_H

#include "atp/bti_at.h" 


/* Extern function for GSM definition */
/******************************************************************************
* Function name: bti_at_init_req
*
* Description : This function is called by GSM in order to register GSM to BT PS.
*				
*
* Parameters :  None
*
* Return     :   None // function bti_at_init_cnf() used to issue result
*
* History			: 0.1 (10-Jully-2000)
*					  0.2 (01-Jan-2001) 
*
******************************************************************************/
void bti_at_init_req(void);


/******************************************************************************
* Function name: bti_at_deinit_ind
*
* Description : This function is called by GSM to de-register GSM from BT PS
*				Not Used
*
* Parameters :  None
*
* Return     :   None
*				
*
* History			: 0.1 (10-Jully-2000)
*					  0.2 (01-Jan-2001) 
*
******************************************************************************/
void bti_at_deinit_req(void);


/******************************************************************************
* Function name: bti_at_open_port_res
*
* Description : This function is called by GSM to accept or refuse
*				an open port request issued by BT side
*
*
* Parameters :  gsm_port_nb = number of the gsm port
*				bti_gsm_port_info = custom information to open a GSM/GPRS port
*				result	= BTI_ACK or BTI_NAK 
*
* Return     :   None
*				
*
* History			: 0.1 (10-Jully-2000)
*					  0.2 (01-Jan-2001) 
*
******************************************************************************/
void bti_at_open_port_res(T_BTI_PORT_NB gsm_port_nb,
						  T_BTI_GSM_PORT_INFO gsm_port_info,
						  T_BTI_ACK ack);


/******************************************************************************
* Function name: bti_at_close_port_res
*
* Description : Not used by BT PS - Port is always closed whatever the 
*				acknowledge is
*
* Parameters :  gsm_port_nb = number of the gsm port
*
* Return     :   None
*				
*
* History			: 0.1 (10-Jully-2000)
*
******************************************************************************/
void  bti_at_close_port_res(T_BTI_PORT_NB gsm_port_nb);


/******************************************************************************
* Function name: bti_at_cmd_req
*
* Description : This function is called by GSM to provide unsollicited code
*				or information text to BT PS 
*
* Parameters :  gsm_port_nb = number of the gsm port
*				cmd = command in text format
*
* Return     :   None
*				
*
* History			: 0.1 (10-Jully-2000) 
*
******************************************************************************/
void  bti_at_cmd_req(T_BTI_PORT_NB gsm_port_nb,
					 char * cmd);


/******************************************************************************
* Function name: bti_at_cmd_res
*
* Description : This function is called by GSM to provide result code to BT
*
* Parameters :  gsm_port_nb = number of the gsm port
*				cmd = command in text format
*
* Return     :   None
*				
*
* History			: 0.1 (10-Jully-2000) 
*
******************************************************************************/
void  bti_at_cmd_res(T_BTI_PORT_NB gsm_port_nb,
					 char * cmd);


/******************************************************************************
* Function name: bti_at_abort_res
*
* Description : This function is called by GSM to comfirm a command abort
*			
*
* Parameters :  gsm_port_nb = number of the gsm port
*
* Return     :   None
*				
*
* History		: 0.1 (10-Jully-2000) 
*
******************************************************************************/
void  bti_at_abort_res(T_BTI_PORT_NB gsm_port_nb);



/******************************************************************************
* Function name: bti_get_bt_data
*
* Description : This function is called by GSM to get data from BT side . 
*				Copy is processed by BT side
*
* Parameters :  gsm_port_nb = number of the gsm port
*				data_buffer = pointer on a buffer in which data can be copied  
*				nb_bytes_to_copy = number of bytes to copy into data_buffer
*
* Return     :  None 
*			
*
* History			: 0.1 (10-Jully-2000) 
*					  0.2 (01-Jan-2001) 
*
******************************************************************************/
void bti_get_bt_data (T_BTI_PORT_NB gsm_port_nb,
					  char * data_buffer,
					  unsigned long nb_bytes_to_copy);



/******************************************************************************
* Function name: bti_data_ready_req
*
* Description : This function is called by GSM to indicate that data are 
*				available for BT PS.
*				 				
*
* Parameters :  gsm_port_nb = number of the gsm port
*				nb_bytes_available = number of bytes of data available
*
* Return     :  None
*
* History			: 0.1 (10-Jully-2000) 
*					  0.2 (01-Jan-2001) 
*
******************************************************************************/
void bti_data_ready_req (T_BTI_PORT_NB gsm_port_nb,
						 unsigned long  nb_bytes_available);


/******************************************************************************
* Function name: bti_data_ready_res
*
* Description : This function is called by GSM to indicate that it can receive 
*				new data from BT PS
*				 				
*
* Parameters :  gsm_port_nb = number of the gsm port
*
* Return     :  None
*
* History			: 0.1 (10-Jully-2000) 
*					  0.2 (01-Jan-2001) 
*
******************************************************************************/
void bti_data_ready_res (T_BTI_PORT_NB gsm_port_nb);


/******************************************************************************
* Function name: bti_at_signal_change_req
*
* Description : This function is called by GSM to provide a new signal line status 
*				to BT
*				 				
*
* Parameters :  gsm_port_nb = number of the gsm port
*				dce_signal = signal value
*				ring_type_1 = voice, data or fax
*				ring_type_2 = not used
*
* Return     :  None
*
* History			: 0.1 (01-Jan-2001) 
*
******************************************************************************/
void bti_at_signal_change_req (T_BTI_PORT_NB gsm_port_nb,
							   T_BTI_AT_DCE_SIGNAL dce_signal,
							   T_BTI_AT_RING_TYPE ring_type_1,
							   T_BTI_AT_RING_TYPE ring_type_2);


#endif