FreeCalypso > hg > fc-magnetite
view src/cs/drivers/drv_core/clkm/clkm.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
/****************************************************************************** TEXAS INSTRUMENTS INCORPORATED PROPRIETARY INFORMATION Property of Texas Instruments -- For Unrestricted Internal Use Only Unauthorized reproduction and/or distribution is strictly prohibited. This product is protected under copyright law and trade secret law as an unpublished work. Created 1987, (C) Copyright 1997 Texas Instruments. All rights reserved. Filename : clkm.h Description : Header file for the CLKM module Project : drivers Author : pmonteil@tif.ti.com Patrice Monteil. Version number : 1.19 Date and time : 07/01/03 Previous delta : 10/19/01 15:25:25 SCCS file : /db/gsm_asp/db_ht96/dsp_0/gsw/rel_0/mcu_l1/release_gprs/mod/emu_p/EMU_P_FRED_CLOCK/drivers1/common/SCCS/s.clkm.h Sccs Id (SID) : '@(#) clkm.h 1.10 10/23/01 14:34:54 ' *****************************************************************************/ #include "l1sw.cfg" #include "chipset.cfg" #include "board.cfg" #if (OP_L1_STANDALONE == 0) #include "main/sys_types.h" #else #include "sys_types.h" #endif #if (CHIPSET == 12) #include "sys_map.h" #endif #if (CHIPSET == 12) #define CLKM_ARM_CLK C_MAP_CLKM_BASE /* CLKM registers addr. */ #else #define CLKM_ARM_CLK MEM_CLKM_ADDR /* CLKM ARM CLock Control reg.*/ #endif #define CLKM_MCLK_EN 0x0001 #if ((CHIPSET == 4) || (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12)) #define MASK_CLKIN 0x0006 #endif #if ((CHIPSET == 4) || (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12)) #define CLKM_CLKIN0 0x0002 // Mask to select between DPLL and VTCXO or CLKIN #else #define CLKM_LOW_FRQ 0x0002 // Mask to select low frequency input CLK_32K #endif #define CLKM_CLKIN_SEL 0x0004 // Mask to select between VTCXO and CLKIN #if ((CHIPSET == 4) || (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12)) #define CLKM_ARM_MCLK_XP5 0x0008 // Mask to enable the 1.5 or 2.5 division factor #define CLKM_MCLK_DIV 0x0070 // Mask to configure the division factor #else #define MASK_ARM_MCLK_1P5 0x0008 // Mask to enable the 1.5 division factor #define CLKM_MCLK_DIV 0x0030 // Mask to configure the division factor #endif #define CLKM_DEEP_PWR 0x0f00 // Mask to configure deep power #define CLKM_DEEP_SLEEP 0x1000 // Mask to configure deep sleep #if ((CHIPSET == 4) || (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12)) #define CLKM_SEL_DPLL 0x0000 // Selection of DPLL for ARM clock generation #define CLKM_SEL_VTCXO 0x0001 // Selection of VTCXO for ARM clock generation #define CLKM_SEL_CLKIN 0x0003 // Selection of CLKIN for ARM clock generation #define CLKM_ENABLE_XP5 0x0001 // Enable 1.5 or 2.5 division factor #define CLKM_DISABLE_XP5 0x0000 // Disable 1.5 or 2.5 division factor #define CLKM_ARM_MCLK_DIV_OFFSET 4 // Offset of ARM_MCLK_DIV bits in CNTL_ARM_CLK register #define CLKM_ARM_CLK_RESET 0x1081 // Reset value of CNTL_ARM_CLK register #endif #if (CHIPSET == 12) #define CLKM_CNTL_ARM_CLK (C_MAP_CLKM_BASE + 0x00) #define CLKM_CNTL_CLK (C_MAP_CLKM_BASE + 2) /* CLKM Clock Control reg. */ #else #define CLKM_CNTL_ARM_CLK (MEM_CLKM_ADDR + 0x00) #define CLKM_CNTL_CLK (MEM_CLKM_ADDR + 2) /* CLKM Clock Control reg. */ #endif #define CLKM_IRQ_DIS 0x0001 // IRQ clock is disabled and enabled according to the sleep command #define CLKM_BRIDGE_DIS 0x0002 // BRIDGE clock is disabled and enabled according to the sleep command #define CLKM_TIMER_DIS 0x0004 // TIMER clock is disabled and enabled according to the sleep command #if ((CHIPSET == 4) || (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12)) #define CLKM_DPLL_DIS 0x0008 // DPLL is set in IDLE when both DSP and ARM are respectively in IDLE3 and sleep mode #else #define CLKM_PLL_SEL 0x0008 // CLKIN input is connected to the PLL #endif #define CLKM_CLKOUT_EN 0x0010 // Enable CLKOUT(2:0) output clocks #if (CHIPSET == 4) #define CLKM_EN_IDLE3_FLG 0x0020 // DSP idle flag control the API wait state #define CLKM_VTCXO_26 0x0040 // VTCXO is divided by 2 #elif (CHIPSET == 6) #define CLKM_VTCXO_26 0x0040 // VTCXO is divided by 2 #elif (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12) #define CLKM_EN_IDLE3_FLG 0x0020 // DSP idle flag control the API wait state #define CLKM_VCLKOUT_2 0x0040 // VTCXO is divided by 2 #define CLKM_VTCXO_2 0x0080 // Input clock to DPLL is divided by 2 #endif #if (CHIPSET == 12) #define CLKM_CNTL_RST (C_MAP_CLKM_BASE + 4) /* CLKM Reset Control reg. */ #else #define CLKM_CNTL_RST (MEM_CLKM_ADDR + 4) /* CLKM Reset Control reg. */ #endif #define CLKM_LEAD_RST 0x0002 #define CLKM_EXT_RST 0x0004 #if ((CHIPSET == 4) || (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12)) #define DPLL_LOCK 0x0001 // Mask of DPLL lock status #define DPLL_BYPASS_DIV 0x000C // Mask of bypass mode configuration #define DPLL_PLL_ENABLE 0x0010 // Enable DPLL #define DPLL_PLL_DIV 0x0060 // Mask of division factor configuration #define DPLL_PLL_MULT 0x0F80 // Mask of multiply factor configuration #define DPLL_BYPASS_DIV_1 0x00 // Configuration of bypass mode divided by 1 #define DPLL_BYPASS_DIV_2 0x01 // Configuration of bypass mode divided by 2 #define DPLL_BYPASS_DIV_4 0x10 // Configuration of bypass mode divided by 4 #define DPLL_BYPASS_DIV_OFFSET 2 // Offset of bypass bits configuration #define DPLL_PLL_DIV_OFFSET 5 // Offset of division bits configuration #define DPLL_PLL_MULT_OFFSET 7 // Offset of multiply bits configuration #define DPLL_LOCK_DIV_1 0x0000 // Divide by 1 when DPLL is locked #define DPLL_LOCK_DIV_2 0x0001 // Divide by 2 when DPLL is locked #define DPLL_LOCK_DIV_3 0x0002 // Divide by 3 when DPLL is locked #define DPLL_LOCK_DIV_4 0x0003 // Divide by 4 when DPLL is locked #else #define CLKM_LEAD_PLL_CNTL (MEM_CLKM_ADDR + 6) /* Lead PLL */ #define CLKM_PLONOFF 0x0001 // PLL enable signal #define CLKM_PLMUL 0x001e // Mask of multiply factor configuration #define CLKM_PLLNDIV 0x0020 // PLL or divide mode selection #define CLKM_PLDIV 0x0040 // Mask of multiply factor configuration #define CLKM_LEAD_PLL_CNTL_MSK 0x00ef // Mask of PLL control register #endif #if (CHIPSET == 12) #define CLKM_CNTL_CLK_DSP (C_MAP_CLKM_BASE + 0x8A) /* CLKM CNTL_CLK_REG register */ #define CLKM_NB_DSP_DIV_VALUE 4 #define CLKM_DSP_DIV_1 0x00 #define CLKM_DSP_DIV_1_5 0x01 #define CLKM_DSP_DIV_2 0x02 #define CLKM_DSP_DIV_3 0x03 #define CLKM_DSP_DIV_MASK 0x0003 extern const double dsp_div_value[CLKM_NB_DSP_DIV_VALUE]; /*--------------------------------------------------------------- * CLKM_DSP_DIV_FACTOR() *-------------------------------------------------------------- * Parameters : none * Return : none * Functionality : Set the DSP division factor *--------------------------------------------------------------*/ #define CLKM_DSP_DIV_FACTOR(d_dsp_div) (* (volatile SYS_UWORD16 *) CLKM_CNTL_CLK_DSP = d_dsp_div) /*--------------------------------------------------------------- * CLKM_READ_DSP_DIV() *-------------------------------------------------------------- * Parameters : none * Return : none * Functionality : Read DSP division factor *--------------------------------------------------------------*/ #define CLKM_READ_DSP_DIV ((* (volatile SYS_UWORD16 *) CLKM_CNTL_CLK_DSP) & CLKM_DSP_DIV_MASK) #define CLKM_GET_DSP_DIV_VALUE dsp_div_value[CLKM_READ_DSP_DIV] #endif /*--------------------------------------------------------------- * CLKM_SETLEADRESET() *-------------------------------------------------------------- * Parameters : none * Return : none * Functionality : Set the LEAD reset signal *--------------------------------------------------------------*/ #define CLKM_SETLEADRESET (* (volatile SYS_UWORD16 *) CLKM_CNTL_RST |= CLKM_LEAD_RST) /*--------------------------------------------------------------- * CLKM_RELEASELEADRESET() *-------------------------------------------------------------- * Parameters : none * Return : none * Functionality : Release the LEAD reset signal *--------------------------------------------------------------*/ #define CLKM_RELEASELEADRESET (* (volatile SYS_UWORD16 *) CLKM_CNTL_RST &= ~CLKM_LEAD_RST) /*--------------------------------------------------------------- * CLKM_SETEXTRESET() *-------------------------------------------------------------- * Parameters : none * Return : none * Functionality : Set the external reset signal *--------------------------------------------------------------*/ #define CLKM_SETEXTRESET ( * (volatile SYS_UWORD16 *) CLKM_CNTL_RST |= CLKM_EXT_RST) /*--------------------------------------------------------------- * CLKM_CLEAREXTRESET() *-------------------------------------------------------------- * Parameters : none * Return : none * Functionality : Clear the external reset signal *--------------------------------------------------------------*/ #define CLKM_CLEAREXTRESET (* (volatile SYS_UWORD16 *) CLKM_CNTL_RST &= ~CLKM_EXT_RST) /*--------------------------------------------------------------- * CLKM_POWERDOWNARM() *-------------------------------------------------------------- * Parameters : none * Return : none * Functionality : Power down the ARM mcu *--------------------------------------------------------------*/ #define CLKM_POWERDOWNARM (* (volatile SYS_UWORD16 *) CLKM_ARM_CLK &= ~CLKM_MCLK_EN) /*--------------------------------------------------------------- * CLKM_SET1P5() *-------------------------------------------------------------- * Parameters : none * Return : none * Functionality : Set ARM_MCLK_1P5 bit *--------------------------------------------------------------*/ #if ((CHIPSET == 4) || (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12)) #define CLKM_SETXP5 ( * (volatile SYS_UWORD16 *) CLKM_ARM_CLK |= CLKM_ARM_MCLK_XP5) #else #define CLKM_SET1P5 ( * (volatile SYS_UWORD16 *) CLKM_ARM_CLK |= 0x0008) #endif /*--------------------------------------------------------------- * CLKM_RESET1P5() *-------------------------------------------------------------- * Parameters : none * Return : none * Functionality : Reset ARM_MCLK_1P5 bit *--------------------------------------------------------------*/ #if ((CHIPSET == 4) || (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12)) #define CLKM_RESETXP5 ( * (volatile SYS_UWORD16 *) CLKM_ARM_CLK &= ~CLKM_ARM_MCLK_XP5) #else #define CLKM_RESET1P5 ( * (volatile SYS_UWORD16 *) CLKM_ARM_CLK &= 0xfff7) #endif /*--------------------------------------------------------------- * CLKM_INITCNTL() *-------------------------------------------------------------- * Parameters : value to write in the CNTL register * Return : none * Functionality :Initialize the CLKM Control Clock register *--------------------------------------------------------------*/ #define CLKM_INITCNTL(value) (* (volatile SYS_UWORD16 *) CLKM_CNTL_CLK |= value) #if ((CHIPSET != 4) && (CHIPSET != 7) && (CHIPSET != 8) && (CHIPSET != 10) && (CHIPSET != 11) && (CHIPSET != 12)) /*--------------------------------------------------------------- * CLKM_INITLEADPLL() *-------------------------------------------------------------- * Parameters : value to write in the CNTL_PLL LEAD register * Return : none * Functionality :Initialize LEAD PLL control register *--------------------------------------------------------------*/ #define CLKM_INITLEADPLL(value) (* (volatile SYS_UWORD16 *) CLKM_LEAD_PLL_CNTL = value) #endif #if ((CHIPSET == 4) || (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12)) /*-------------------------------------------------------------- * CLKM_DPLL_SWITH_OFF_MODE_CONFIG() *-------------------------------------------------------------- * Parameters : None * Return : none * Functionality : Configure DPLL switch off mode *--------------------------------------------------------------*/ #define CLKM_DPLL_SWITH_OFF_MODE_CONFIG (* (volatile SYS_UWORD16 *) CLKM_CNTL_CLK |= \ (CLKM_DPLL_DIS | CLKM_IRQ_DIS | CLKM_BRIDGE_DIS | CLKM_TIMER_DIS)) /*-------------------------------------------------------------- * CLKM_RESET_DPLL_SWITH_OFF_MODE_CONFIG() *-------------------------------------------------------------- * Parameters : None * Return : none * Functionality : Reset configuration of DPLL switch off mode *--------------------------------------------------------------*/ #define CLKM_RESET_DPLL_SWITH_OFF_MODE_CONFIG (* (volatile SYS_UWORD16 *) CLKM_CNTL_CLK &=\ ~(CLKM_DPLL_DIS | CLKM_IRQ_DIS | CLKM_BRIDGE_DIS | CLKM_TIMER_DIS)) /*-------------------------------------------------------------- * CLKM_FORCE_API_HOM_IN_IDLE3() *-------------------------------------------------------------- * Parameters : None * Return : none * Functionality : SAM/HOM wait-state register force to HOM when * DSP is in IDLE3 mode */ /*--------------------------------------------------------------*/ #define CLKM_FORCE_API_HOM_IN_IDLE3 (* (volatile SYS_UWORD16 *) CLKM_CNTL_CLK |= (CLKM_EN_IDLE3_FLG)) #if (CHIPSET == 4) /*-------------------------------------------------------------- * CLKM_USE_VTCXO_26MHZ() *-------------------------------------------------------------- * Parameters : None * Return : none * Functionality : Divide by 2 the clock used by the peripheral * when using external VTCXO at 26 MHz instead * of 13MHz *--------------------------------------------------------------*/ #define CLKM_USE_VTCXO_26MHZ (* (volatile SYS_UWORD16 *) CLKM_CNTL_CLK |= (CLKM_VTCXO_26)) /*-------------------------------------------------------------- * CLKM_UNUSED_VTCXO_26MHZ() *-------------------------------------------------------------- * Parameters : None * Return : none * Functionality : Use VTCXO=13MHz *--------------------------------------------------------------*/ #define CLKM_UNUSED_VTCXO_26MHZ (* (volatile SYS_UWORD16 *) CLKM_CNTL_CLK &= ~(CLKM_VTCXO_26)) #elif (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12) /*-------------------------------------------------------------- * CLKM_UNUSED_VTCXO_26MHZ() *-------------------------------------------------------------- * Parameters : None * Return : none * Functionality : Use VTCXO=13MHz *--------------------------------------------------------------*/ #define CLKM_USE_VTCXO_26MHZ (* (volatile SYS_UWORD16 *) CLKM_CNTL_CLK |= (CLKM_VTCXO_2)) #define CLKM_UNUSED_VTCXO_26MHZ (* (volatile SYS_UWORD16 *) CLKM_CNTL_CLK &= ~(CLKM_VCLKOUT_2 | CLKM_VTCXO_2)) #endif #if (CHIPSET == 12) #define DPLL_SET_PLL_ENABLE (* (volatile SYS_UWORD16 *) C_MAP_DPLL_BASE |= DPLL_PLL_ENABLE) #define DPLL_RESET_PLL_ENABLE (* (volatile SYS_UWORD16 *) C_MAP_DPLL_BASE &= ~DPLL_PLL_ENABLE) #define DPLL_INIT_BYPASS_MODE(d_bypass_mode) { \ *((volatile SYS_UWORD16 *) C_MAP_DPLL_BASE) &= ~DPLL_BYPASS_DIV; \ *((volatile SYS_UWORD16 *) C_MAP_DPLL_BASE) |= (d_bypass_mode << DPLL_BYPASS_DIV_OFFSET); \ } #define DPLL_INIT_DPLL_CLOCK(d_pll_div, d_pll_mult) { \ *((volatile SYS_UWORD16 *) C_MAP_DPLL_BASE) &= ~(DPLL_PLL_DIV | DPLL_PLL_MULT); \ *((volatile SYS_UWORD16 *) C_MAP_DPLL_BASE) |= (d_pll_div << DPLL_PLL_DIV_OFFSET) |\ (d_pll_mult << DPLL_PLL_MULT_OFFSET); \ } #define DPLL_READ_DPLL_DIV ( ((* (volatile SYS_UWORD16 *) C_MAP_DPLL_BASE) & DPLL_PLL_DIV) >> DPLL_PLL_DIV_OFFSET) #define DPLL_READ_DPLL_MUL ( ((* (volatile SYS_UWORD16 *) C_MAP_DPLL_BASE) & DPLL_PLL_MULT)>> DPLL_PLL_MULT_OFFSET) #define DPLL_READ_DPLL_LOCK ( (* (volatile SYS_UWORD16 *) C_MAP_DPLL_BASE) & DPLL_LOCK) #else #define DPLL_SET_PLL_ENABLE (* (volatile SYS_UWORD16 *) MEM_DPLL_ADDR |= DPLL_PLL_ENABLE) #define DPLL_RESET_PLL_ENABLE (* (volatile SYS_UWORD16 *) MEM_DPLL_ADDR &= ~DPLL_PLL_ENABLE) #define DPLL_INIT_BYPASS_MODE(d_bypass_mode) { \ *((volatile SYS_UWORD16 *) MEM_DPLL_ADDR) &= ~DPLL_BYPASS_DIV; \ *((volatile SYS_UWORD16 *) MEM_DPLL_ADDR) |= (d_bypass_mode << DPLL_BYPASS_DIV_OFFSET); \ } #define DPLL_INIT_DPLL_CLOCK(d_pll_div, d_pll_mult) { \ *((volatile SYS_UWORD16 *) MEM_DPLL_ADDR) &= ~(DPLL_PLL_DIV | DPLL_PLL_MULT); \ *((volatile SYS_UWORD16 *) MEM_DPLL_ADDR) |= (d_pll_div << DPLL_PLL_DIV_OFFSET) |\ (d_pll_mult << DPLL_PLL_MULT_OFFSET); \ } #define DPLL_READ_DPLL_DIV ( ((* (volatile SYS_UWORD16 *) MEM_DPLL_ADDR) & DPLL_PLL_DIV) >> DPLL_PLL_DIV_OFFSET) #define DPLL_READ_DPLL_MUL ( ((* (volatile SYS_UWORD16 *) MEM_DPLL_ADDR) & DPLL_PLL_MULT)>> DPLL_PLL_MULT_OFFSET) #define DPLL_READ_DPLL_LOCK ( (* (volatile SYS_UWORD16 *) MEM_DPLL_ADDR) & DPLL_LOCK) #endif /* (CHIPSET == 12) */ #endif /* ----- Prototypes ----- */ #if (BOARD == 34) void CLKM_InitARMClock(int src, int div); #elif ((CHIPSET == 4) || (CHIPSET == 7) || (CHIPSET == 8) || (CHIPSET == 10) || (CHIPSET == 11) || (CHIPSET == 12)) void CLKM_InitARMClock(SYS_UWORD16 clk_src, SYS_UWORD16 clk_div, SYS_UWORD16 clk_xp5); #else void CLKM_InitARMClock(SYS_UWORD16 clk_src, SYS_UWORD16 clk_div); #endif #if (BOARD == 34) void CLKM_SetMclkDiv(int div); void CLKM_EnableDPLL(int enable); void CLKM_EnableSharedMemClock(int enable); void CLKM_InitLeadClock(int onoff, int mul, int ndiv, int div); #endif void wait_ARM_cycles(SYS_UWORD32 cpt_loop); void initialize_wait_loop(void); SYS_UWORD32 convert_nanosec_to_cycles(SYS_UWORD32 time);