ath9k_htc/target_firmware/magpie_fw_dev/target/inc/magpie/magpie/rom_cfg.h

   1 /*
   2  * Copyright (c) 2013 Qualcomm Atheros, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted (subject to the limitations in the
   7  * disclaimer below) provided that the following conditions are met:
   8  *
   9  *  * Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  *  * Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the
  15  *    distribution.
  16  *
  17  *  * Neither the name of Qualcomm Atheros nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific prior written permission.
  20  *
  21  * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
  22  * GRANTED BY THIS LICENSE.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
  23  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
  24  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  26  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  30  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  32  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  33  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35 /*************************************************************************/
  36 /*  Copyright (c) 2006 Atheros Communications, Inc., All Rights Reserved */
  37 /*                                                                       */
  38 /*  Module Name : rom_cfg.h                                              */
  39 /*                                                                       */
  40 /*  Abstract                                                             */
  41 /*      This file contains definition of platform and sysmte config   .  */
  42 /*                                                                       */
  43 /*  NOTES                                                                */
  44 /*      None                                                             */
  45 /*                                                                       */
  46 /*************************************************************************/
  47
  48 #ifndef _ROM_CFG_H_
  49 #define _ROM_CFG_H_
  50
  51 /************************** FPGA version **************************/
  52 #define MAGPIE_FPGA_RAM_256K         1
  53
  54 /************************** SYSTEM WIDE ***************************/
  55 /* Release Code :
  56  * D : Daily build (Development)
  57  * R : Official Release
  58  */
  59 #define ATH_VER_RELEASE_CODE        "D"
  60 #define ATH_VER_PLATFORM_NUMBER     "0"
  61 #define ATH_VER_MAJOR_NUMBER        "0"
  62 #define ATH_VER_MINOR_NUMBER        "0"
  63 #define ATH_VER_BUILD_NUMBER        "3"
  64
  65 #define ATH_VERSION_STR             "["ATH_VER_RELEASE_CODE       "." \
  66                                     ATH_VER_PLATFORM_NUMBER "." \
  67                                     ATH_VER_MAJOR_NUMBER    "." \
  68                                     ATH_VER_MINOR_NUMBER    "." \
  69                                     ATH_VER_BUILD_NUMBER    "]"
  70
  71 /* ROM Code Version (16 bit)
  72  * Bit 15   : 0 means ASIC, 1 means FPGA
  73  * Bit 14   : 0 means ROM, 1 means FLASH
  74  * Bit 13-8 : Major Version Number
  75  * Bit 7-0  : Minor Version Number
  76  */
  77 #if defined(MAGPIE_FPGA)
  78 #define ROM_PLATFORM             (1)
  79 #else
  80 #define ROM_PLATFORM             (0)
  81 #endif
  82
  83 /* Define ROM Code Version Number here */
  84 #define ROM_MAJOR_VER_NUM        (2)
  85 #define ROM_MINOR_VER_NUM        (2)
  86
  87 #define BOOTROM_VER              ( (ROM_PLATFORM<<15) | (ROM_MAJOR_VER_NUM<<8) | ROM_MINOR_VER_NUM )
  88
  89
  90 #define SYSTEM_FREQ                 40
  91
  92 #define SYSTEM_CLK                  SYSTEM_FREQ*1000*1000    //40mhz
  93
  94 #define ONE_MSEC                    (SYSTEM_FREQ*1000)
  95
  96 /////////////////////////////////////////////////////////////////
  97 /*
  98  * Supported reference clock speeds.
  99  *
 100  * Note: MAC HAL code has multiple tables indexed by these values,
 101  * so do not rearrange them.  Add any new refclk values at the end.
 102  */
 103 typedef enum {
 104     SYS_CFG_REFCLK_UNKNOWN      = -1, /* Unsupported ref clock -- use PLL Bypass */
 105     SYS_CFG_REFCLK_10_MHZ       = 0,
 106     SYS_CFG_REFCLK_20_MHZ       = 1,
 107     SYS_CFG_REFCLK_40_MHZ       = 2,
 108 } A_refclk_speed_t;
 109
 110 /////////////////////////////////////////////////////////////////
 111
 112
 113 /////////////////////////////////////////////////////////////////
 114 // cmnos interface
 115
 116     #define SYSTEM_MODULE_MEM           1
 117
 118     #define SYSTEM_MODULE_MISC          1
 119
 120     #define SYSTEM_MODULE_USB           1
 121
 122     #if SYSTEM_MODULE_USB
 123         #define SYSTEM_MODULE_HP_EP1    1
 124         #define SYSTEM_MODULE_HP_EP5    1
 125         #define SYSTEM_MODULE_HP_EP6    1
 126     #endif
 127
 128     #define SYSTEM_MODULE_INTR          1
 129
 130     #define SYSTEM_MODULE_CLOCK         1
 131
 132         #define SYSTEM_MODULE_DESC              0
 133
 134     #define SYSTEM_MODULE_ALLOCRAM      1
 135
 136     #define SYSTEM_MODULE_UART          1              //uart module to dump the dbg message
 137
 138     #define SYSTEM_MODULE_TIMER         1               // a virtual timer, before we don't have the real timer
 139
 140     #define SYSTEM_MODULE_WDT           1                 // a watchdog timer
 141
 142     #define SYSTEM_MODULE_EEPROM        1           // a eeprom interface (pcie_rc's eeprom not apb eeprom)
 143
 144     #if SYSTEM_MODULE_UART
 145         #define SYSTEM_MODULE_PRINT     1   // dependency on UART module
 146         #define SYSTEM_MODULE_DBG       0  // dependency on PRINT & UART module
 147     #endif
 148
 149     #define SYSTEM_MODULE_ROM_PATCH     1           // patch install module
 150
 151 #define SYSTEM_MODULE_PCI                               1
 152
 153 #define SYSTEM_MODULE_GMAC                              1
 154
 155 #define SYSTEM_MODULE_SFLASH            0
 156
 157 #define SYSTEM_MODULE_TESTING           0               // backdoor test module
 158
 159 #if SYSTEM_MODULE_TESTING
 160 #define SYSTEM_MODULE_MEMORY_TEST       0
 161 #define SYSTEM_MODULE_DHRYSTONE_TEST    0
 162
 163 #define SYSTEM_MODULE_SYS_MONITOR       0
 164 #define SYSTEM_MODULE_IDLE_TASK         0
 165
 166 #endif /* SYSTEM_MODULE_TESTING */
 167
 168 /****************************** UART ******************************/
 169 #define UART_INPUT_CLK                  SYSTEM_CLK
 170 #define UART_DEFAULT_BAUD               19200
 171 #define UART_RETRY_COUNT                10000
 172
 173 /****************************** USB *******************************/
 174
 175 /* Firmware Loopback */
 176 #define ZM_FM_LOOPBACK                  0
 177 #define ZM_SELF_TEST_MODE               1         // USB-IF Eye Pattern Test
 178
 179 #define ENABLE_SWAP_DATA_MODE           1       // byte swap function
 180 #define ENABLE_SW_SWAP_DATA_MODE        1
 181
 182 #define ENABLE_STREAM_MODE              0       // stream mode
 183
 184 #define USB_STREAM_MODE_AGG_CNT         0         // 2 packets, 2: 3packets, 3: 4packets etc...
 185 #define USB_STREAM_MODE_TIMEOUT_CTRL    0x0     // the unit is 32 USB (30Mhz) clock cycles
 186 #define USB_STREAM_MODE_HOST_BUF_SZ     (BIT4)    // define the host dma buffer size (bit5,bit4)- 4096(0,0) 8192 (0,1) 16384(1,0) 32768(1,1) bytes
 187
 188 /************************* MEMORY DEFS ***************************/
 189
 190 #if defined(PROJECT_MAGPIE)
 191     #include "magpie_mem.h"
 192 #elif defined(PROJECT_K2)
 193     #include "k2_mem.h"
 194 #endif
 195
 196
 197 // the end of 16 bytes are used to record some debug state and watchdog event and counter
 198 #define WATCH_DOG_MAGIC_PATTERN_ADDR    (SYS_D_RAM_REGION_0_BASE+SYS_RAM_SZIE-0x4)        //  0x53fffc,magic pattern address
 199 #define WATCH_DOG_RESET_COUNTER_ADDR    (SYS_D_RAM_REGION_0_BASE+SYS_RAM_SZIE-0x8)        //  0x53fff8,record the reset counter
 200 #define DEBUG_SYSTEM_STATE_ADDR         (SYS_D_RAM_REGION_0_BASE+SYS_RAM_SZIE-0xc)        //  0x53fff4,record the state of system
 201 #define CURRENT_PROGRAM_ADDR            (SYS_D_RAM_REGION_0_BASE+SYS_RAM_SZIE-0x10)       //  0x53fff0,reserved
 202
 203 #define WATCH_DOG_MAGIC_PATTERN         (*((volatile u32_t*)(WATCH_DOG_MAGIC_PATTERN_ADDR)))
 204 #define WATCH_DOG_RESET_COUNTER         (*((volatile u32_t*)(WATCH_DOG_RESET_COUNTER_ADDR)))
 205 #define DEBUG_SYSTEM_STATE              (*((volatile u32_t*)(DEBUG_SYSTEM_STATE_ADDR)))
 206 #define CURRENT_PROGRAM                 (*((volatile u32_t*)(CURRENT_PROGRAM_ADDR)))
 207
 208 #define WDT_MAGIC_PATTERN                       0x5F574454      //_WDT
 209 #define SUS_MAGIC_PATTERN                       0x5F535553      //_SUS
 210
 211 // move to sys_cfg.h
 212 /************************* WLAN DEFS ***************************/
 213 //#define MAGPIE_ENABLE_WLAN              1
 214 //#define MAGPIE_ENABLE_PCIE              1
 215 //#define MAGPIE_ENABLE_WLAN_IN_TARGET    0
 216 //#define MAGPIE_ENABLE_WLAN_SELF_TX      0
 217
 218 /****************************** WATCH DOG *******************************/
 219 #define WDT_DEFAULT_TIMEOUT_VALUE   3*ONE_MSEC*1000 // Initial value is 3 seconds, firmware changes it to 65 milliseconds
 220
 221 #endif /* _ROM_CFG_H_ */