FreeCalypso > hg > fc-magnetite

view src/g23m-gprs/sm/sm_memory_handler.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 219afcfc6250
children
line wrap: on
line source

/*----------------------------------------------------------------------------
|  Project :  3G PS
|  Module  :  SM
+-----------------------------------------------------------------------------
|             Copyright 2003 Texas Instruments.
|             All rights reserved. 
| 
|             This file is confidential and a trade secret of Texas 
|             Instruments .
|             The receipt of or possession of this file does not convey 
|             any rights to reproduce or disclose its contents or to 
|             manufacture, use, or sell anything it may describe, in 
|             whole, or in part, without the specific written consent of 
|             Texas Instruments. 
+-----------------------------------------------------------------------------
| Purpose:    Memory allocation function definition for the SM Entity.
|             For design details, see:
|             8010.908 SM Detailed Specification
+---------------------------------------------------------------------------*/

/*==== DECLARATION CONTROL =================================================*/

#ifndef SM_MEMORY_HANDLER_H
#define SM_MEMORY_HANDLER_H

/*==== INCLUDES =============================================================*/

/*==== CONSTS ===============================================================*/

/*==== TYPES ================================================================*/

/*==== EXPORTS ==============================================================*/

/* Memory allocation/free functions */
void sm_pfree(/*@only@*/ /*@out@*/ /*@null@*/void *data);

/*************************************************************/
/* Functions for managing context data structures and arrays */
/*************************************************************/

/*@only@*/ /*@null@*/
struct T_SM_CONTEXT_DATA *
        sm_allocate_context_data(void);

void    sm_assign_context_data_to_nsapi (/*@only@*/
					 struct T_SM_CONTEXT_DATA *context,
					 int /*@alt U8@*/ nsapi);

/*@observer@*/
struct T_SM_CONTEXT_DATA *
        sm_get_context_data_from_nsapi  (int /*@alt U8@*/ nsapi);

/*@observer@*/ /*@null@*/
struct T_SM_CONTEXT_DATA *
        sm_get_context_data_from_ti     (int /*@alt U8@*/ ti);

void    sm_free_context_data            (/*@only@*/
					 struct T_SM_CONTEXT_DATA *context);

void    sm_free_context_data_by_nsapi   (int /*@alt U8@*/ nsapi);

/*@observer@*/ /*@null@*/
struct T_SM_CONTEXT_DATA *
        sm_insert_mt_context_data       (int /*@alt U8@*/ ti);

/*@null@*/ /*@only@*/
struct T_SM_CONTEXT_DATA *
        sm_extract_mt_context_data      (int /*@alt U8@*/ ti);

void    sm_free_pending_mt_context_by_index(U16 index);

U16     sm_linked_nsapis                (U8 ti);

void    sm_allocate_and_copy_coded_msg  (struct T_SM_CONTEXT_DATA *context,
					 U8                        est_cause,
					 /*@in@*/ T_sdu           *msg);

void    sm_free_coded_msg               (struct T_SM_CONTEXT_DATA *context);

/***********************************************************************/
/*  Network Control Managed Memory Handler Functions                   */
/***********************************************************************/

void    sm_nw_allocate_and_copy_requested_pco(/*@special@*/
					 struct T_SM_CONTEXT_DATA *context,
					 size_t /*@alt U8,U16@*/   pco_len,
					 /*@unique@*/ U8          *pco);

void    sm_nw_allocate_and_copy_negotiated_pco(/*@special@*/
					 struct T_SM_CONTEXT_DATA *context,
					 size_t /*@alt U8@*/       pco_len,
					 /*@unique@*/ U8          *pco);

void    sm_nw_free_requested_pco        (/*@special@*/
					 struct T_SM_CONTEXT_DATA *context);

void    sm_nw_free_negotiated_pco       (/*@special@*/
					 struct T_SM_CONTEXT_DATA *context);

void    sm_nw_allocate_and_copy_apn     (/*@special@*/
					 struct T_SM_CONTEXT_DATA  *context,
					 U8 c_apn, /*@unique@*/ U8 *apn);

void    sm_nw_free_apn                  (/*@special@*/
					 struct T_SM_CONTEXT_DATA *context);

BOOL    sm_nw_is_address_and_apn_equal  (struct T_SM_CONTEXT_DATA *context,
                                         /*@observer@*/T_NAS_ip   *context_address,
				         /*@observer@*/T_M_SM_address *msg_address,
                                         U8 v_apn, T_M_SM_apn *apn);

void    sm_nw_allocate_and_copy_requested_tft(/*@special@*/
					 struct T_SM_CONTEXT_DATA *context,
					 /*@in@*/ T_NAS_tft       *tft);

void    sm_nw_allocate_active_tft       (/*@special@*/
					 struct T_SM_CONTEXT_DATA *context);

void    sm_nw_free_requested_tft        (/*@special@*/
					 struct T_SM_CONTEXT_DATA *context);

void    sm_nw_free_active_tft           (/*@special@*/
					 struct T_SM_CONTEXT_DATA *context);

void    sm_nw_store_requested_address   (struct T_SM_CONTEXT_DATA *context,
					 U8 pdp_type,
					 T_NAS_ctrl_ip_address ctrl_ip_address,
					 T_NAS_ip_address *ip_address);

void    sm_nw_store_negotiated_address  (struct T_SM_CONTEXT_DATA *context,
					 T_M_SM_address           *address,
					 U8                        v_address);

void    sm_nw_copy_negotiated_address_to_requested(struct T_SM_CONTEXT_DATA *);

BOOL    sm_is_address_changed_with_reactivation(struct T_SM_CONTEXT_DATA *context,
                                                   T_M_SM_address       *address,
                                                   U8                 v_address);
#endif /* SM_MEMORY_HANDLER_H */

/*==== END OF FILE ==========================================================*/