view src/condat3/com/include/cl_imei.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 c8bd5a927942
children
line wrap: on
line source

/*
+-----------------------------------------------------------------------------
|  Project :  COMLIB
|  Modul   :  cl_imei
+-----------------------------------------------------------------------------
|  Copyright 2002 Texas Instruments Berlin, AG
|                 All rights reserved.
|
|                 This file is confidential and a trade secret of Texas
|                 Instruments Berlin, AG
|                 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 Berlin, AG.
+-----------------------------------------------------------------------------
|  Purpose :  Definitions of global types used by common library functions
|             and the prototypes of those functions.
+-----------------------------------------------------------------------------
*/
/*
 *  Version 1.0
 */

/**********************************************************************************/

#ifndef CL_IMEI_H
#define CL_IMEI_H

/**********************************************************************************/

/*
 * Compiler switches
 */

  /* Chipset Type          Value          Value name
   * Gemini/Pole Star        0              _ge
   * Hercules                2              _he
 	 * Ulysse                  3              _ul
	 * Samson                  4              _sa
	 * Ulysse G1 13MHz         5              _g1_13
	 * Ulysse G1 26MHz         6              _g1_26
	 * Calypso C05 (rev. A)    7              _cal
   * Calypso C05 (rev. B)    8              _calb
	 * Ulysse C035             9              _ul35
	 * Calypso C035            10             _cal35
	 * Calypso C035 Lite       11             _lite
   * Calypso+                12             _cplus
   */
/******************************************************************************
 * DIE ID and Platform settings
 *****************************************************************************/
/* DIE ID register
  #define MEM_DEV_ID0     0xFFFEF000
  #define MEM_DEV_ID1     0xFFFEF002
*/
/* For D-Sample: $CHIPSET  =  7 or 8 (=10 for D-sample AMR). */

#ifdef _SIMULATION_
#undef FF_PROTECTED_IMEI
#endif

#ifdef FF_PROTECTED_IMEI
#ifdef CL_IMEI_CALYPSO_PLATFORM
#define CL_IMEI_DIE_ID_REG    (MEM_DEV_ID0 | 0xF010) //+ 0xFFFEF010 for Calypso
#endif
#if !defined (CL_IMEI_CALYPSO_PLUS_PLATFORM) && !defined (CL_IMEI_CALYPSO_PLATFORM)
#define CL_IMEI_OTHER_PLATFORM
#endif
#endif /* FF_PROTECTED_IMEI */

/* DIE ID SIZE is 4 words (16 bits)long */
#define CL_IMEI_SIZE                  8
#define CL_IMEI_ISDID_SIZE            16
#define CL_IMEI_DIE_ID_SIZE           4

/* Return values */
#define CL_IMEI_OK                    0
#define CL_IMEI_ERROR                -1
#define CL_IMEI_INVALID_DIE_ID       -2
#define CL_IMEI_READ_IMEI_FAILED     -3

/* Possible values for imeiType */
#define CL_IMEI_GET_SECURE_IMEI       0
#define CL_IMEI_GET_STORED_IMEI       1
#define CL_IMEI_CONTROL_IMEI          2

/*
+------------------------------------------------------------------------------
| Function    : cl_get_imeisv
+------------------------------------------------------------------------------
| Description : Common IMEI getter function
|
| Parameters  : imeiBufSize  - size of buffer where to store IMEI, min 8 BYTEs
|               *imeiBufPtr  - pointer to buffer where to store the IMEI
|               imeiType     - indicates, if the IMEI should be read from
|                              FFS/Secure ROM (value=CL_IMEI_GET_SECURE_IMEI) or
|                              if the already read and stored IMEI (if available)
|                              should be delivered (value=CL_IMEI_GET_STORED_IMEI)
|                              The second option should be used only by ACI or
|                              BMI to show the IMEISV on mobile's display or
|                              in terminal window, e.g. if user calls *#06#.
|                              For IMEI Control reason (user by ACI), the value
|                              has to be CL_IMEI_CONTROL_IMEI
| Return      :           OK - 0
|                      ERROR - negative values
+------------------------------------------------------------------------------
*/
extern BYTE cl_get_imeisv(USHORT imeiBufSize, UBYTE *imeiBufPtr, UBYTE imeiType);

/**********************************************************************************/


#endif /* CL_IMEI_H */