targets/boardparms/bcm963xx/boardparms.h

   1 /*
   2 <:copyright-gpl
   3
   4  Copyright 2003 Broadcom Corp. All Rights Reserved.
   5
   6  This program is free software; you can distribute it and/or modify it
   7  under the terms of the GNU General Public License (Version 2) as
   8  published by the Free Software Foundation.
   9
  10  This program is distributed in the hope it will be useful, but WITHOUT
  11  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  for more details.
  14
  15  You should have received a copy of the GNU General Public License along
  16  with this program; if not, write to the Free Software Foundation, Inc.,
  17  59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
  18
  19 :>
  20 */
  21 /**************************************************************************
  22  * File Name  : boardparms.h
  23  *
  24  * Description: This file contains definitions and function prototypes for
  25  *              the BCM63xx board parameter access functions.
  26  *
  27  * Updates    : 07/14/2003  Created.
  28  ***************************************************************************/
  29
  30 #if !defined(_BOARDPARMS_H)
  31 #define _BOARDPARMS_H
  32
  33 #if __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /* Return codes. */
  38 #define BP_SUCCESS                              0
  39 #define BP_BOARD_ID_NOT_FOUND                   1
  40 #define BP_VALUE_NOT_DEFINED                    2
  41 #define BP_BOARD_ID_NOT_SET                     3
  42
  43 /* Values for BpGetSdramSize. */
  44 #define BP_MEMORY_8MB_1_CHIP                    0
  45 #define BP_MEMORY_16MB_1_CHIP                   1
  46 #define BP_MEMORY_32MB_1_CHIP                   2
  47 #define BP_MEMORY_64MB_2_CHIP                   3
  48 #define BP_MEMORY_32MB_2_CHIP                   4
  49 #define BP_MEMORY_16MB_2_CHIP                   5
  50
  51 /* Values for EthernetMacInfo PhyType. */
  52 #define BP_ENET_NO_PHY                          0
  53 #define BP_ENET_INTERNAL_PHY                    1
  54 #define BP_ENET_EXTERNAL_PHY                    2
  55 #define BP_ENET_EXTERNAL_SWITCH                 3
  56
  57 /* Values for EthernetMacInfo Configuration type. */
  58 #define BP_ENET_CONFIG_MDIO                     0       /* Internal PHY, External PHY, Switch+(no GPIO, no SPI, no MDIO Pseudo phy */
  59 #define BP_ENET_CONFIG_GPIO                     1       /* Bcm96345GW board + Bcm5325M/E */
  60 #define BP_ENET_CONFIG_MDIO_PSEUDO_PHY          2       /* Bcm96348GW board + Bcm5325E */
  61 #define BP_ENET_CONFIG_SPI_SSB_0                3       /* Bcm96348GW board + Bcm5325M/E */
  62 #define BP_ENET_CONFIG_SPI_SSB_1                4       /* Bcm96348GW board + Bcm5325M/E */
  63 #define BP_ENET_CONFIG_SPI_SSB_2                5       /* Bcm96348GW board + Bcm5325M/E */
  64 #define BP_ENET_CONFIG_SPI_SSB_3                6       /* Bcm96348GW board + Bcm5325M/E */
  65
  66 /* Values for EthernetMacInfo Reverse MII. */
  67 #define BP_ENET_NO_REVERSE_MII                  0
  68 #define BP_ENET_REVERSE_MII                     1
  69
  70 /* Values for VoIPDSPInfo DSPType. */
  71 #define BP_VOIP_NO_DSP                          0
  72 #define BP_VOIP_DSP                             1
  73
  74
  75 /* Values for GPIO pin assignments (AH = Active High, AL = Active Low). */
  76 #define BP_ACTIVE_MASK                          0x8000
  77 #define BP_ACTIVE_HIGH                          0x0000
  78 #define BP_ACTIVE_LOW                           0x8000
  79 #define BP_GPIO_0_AH                            (0  | BP_ACTIVE_HIGH)
  80 #define BP_GPIO_0_AL                            (0  | BP_ACTIVE_LOW)
  81 #define BP_GPIO_1_AH                            (1  | BP_ACTIVE_HIGH)
  82 #define BP_GPIO_1_AL                            (1  | BP_ACTIVE_LOW)
  83 #define BP_GPIO_2_AH                            (2  | BP_ACTIVE_HIGH)
  84 #define BP_GPIO_2_AL                            (2  | BP_ACTIVE_LOW)
  85 #define BP_GPIO_3_AH                            (3  | BP_ACTIVE_HIGH)
  86 #define BP_GPIO_3_AL                            (3  | BP_ACTIVE_LOW)
  87 #define BP_GPIO_4_AH                            (4  | BP_ACTIVE_HIGH)
  88 #define BP_GPIO_4_AL                            (4  | BP_ACTIVE_LOW)
  89 #define BP_GPIO_5_AH                            (5  | BP_ACTIVE_HIGH)
  90 #define BP_GPIO_5_AL                            (5  | BP_ACTIVE_LOW)
  91 #define BP_GPIO_6_AH                            (6  | BP_ACTIVE_HIGH)
  92 #define BP_GPIO_6_AL                            (6  | BP_ACTIVE_LOW)
  93 #define BP_GPIO_7_AH                            (7  | BP_ACTIVE_HIGH)
  94 #define BP_GPIO_7_AL                            (7  | BP_ACTIVE_LOW)
  95 #define BP_GPIO_8_AH                            (8  | BP_ACTIVE_HIGH)
  96 #define BP_GPIO_8_AL                            (8  | BP_ACTIVE_LOW)
  97 #define BP_GPIO_9_AH                            (9  | BP_ACTIVE_HIGH)
  98 #define BP_GPIO_9_AL                            (9  | BP_ACTIVE_LOW)
  99 #define BP_GPIO_10_AH                           (10 | BP_ACTIVE_HIGH)
 100 #define BP_GPIO_10_AL                           (10 | BP_ACTIVE_LOW)
 101 #define BP_GPIO_11_AH                           (11 | BP_ACTIVE_HIGH)
 102 #define BP_GPIO_11_AL                           (11 | BP_ACTIVE_LOW)
 103 #define BP_GPIO_12_AH                           (12 | BP_ACTIVE_HIGH)
 104 #define BP_GPIO_12_AL                           (12 | BP_ACTIVE_LOW)
 105 #define BP_GPIO_13_AH                           (13 | BP_ACTIVE_HIGH)
 106 #define BP_GPIO_13_AL                           (13 | BP_ACTIVE_LOW)
 107 #define BP_GPIO_14_AH                           (14 | BP_ACTIVE_HIGH)
 108 #define BP_GPIO_14_AL                           (14 | BP_ACTIVE_LOW)
 109 #define BP_GPIO_15_AH                           (15 | BP_ACTIVE_HIGH)
 110 #define BP_GPIO_15_AL                           (15 | BP_ACTIVE_LOW)
 111 #define BP_GPIO_16_AH                           (16 | BP_ACTIVE_HIGH)
 112 #define BP_GPIO_16_AL                           (16 | BP_ACTIVE_LOW)
 113 #define BP_GPIO_17_AH                           (17 | BP_ACTIVE_HIGH)
 114 #define BP_GPIO_17_AL                           (17 | BP_ACTIVE_LOW)
 115 #define BP_GPIO_18_AH                           (18 | BP_ACTIVE_HIGH)
 116 #define BP_GPIO_18_AL                           (18 | BP_ACTIVE_LOW)
 117 #define BP_GPIO_19_AH                           (19 | BP_ACTIVE_HIGH)
 118 #define BP_GPIO_19_AL                           (19 | BP_ACTIVE_LOW)
 119 #define BP_GPIO_20_AH                           (20 | BP_ACTIVE_HIGH)
 120 #define BP_GPIO_20_AL                           (20 | BP_ACTIVE_LOW)
 121 #define BP_GPIO_21_AH                           (21 | BP_ACTIVE_HIGH)
 122 #define BP_GPIO_21_AL                           (21 | BP_ACTIVE_LOW)
 123 #define BP_GPIO_22_AH                           (22 | BP_ACTIVE_HIGH)
 124 #define BP_GPIO_22_AL                           (22 | BP_ACTIVE_LOW)
 125 #define BP_GPIO_23_AH                           (23 | BP_ACTIVE_HIGH)
 126 #define BP_GPIO_23_AL                           (23 | BP_ACTIVE_LOW)
 127 #define BP_GPIO_24_AH                           (24 | BP_ACTIVE_HIGH)
 128 #define BP_GPIO_24_AL                           (24 | BP_ACTIVE_LOW)
 129 #define BP_GPIO_25_AH                           (25 | BP_ACTIVE_HIGH)
 130 #define BP_GPIO_25_AL                           (25 | BP_ACTIVE_LOW)
 131 #define BP_GPIO_26_AH                           (26 | BP_ACTIVE_HIGH)
 132 #define BP_GPIO_26_AL                           (26 | BP_ACTIVE_LOW)
 133 #define BP_GPIO_27_AH                           (27 | BP_ACTIVE_HIGH)
 134 #define BP_GPIO_27_AL                           (27 | BP_ACTIVE_LOW)
 135 #define BP_GPIO_28_AH                           (28 | BP_ACTIVE_HIGH)
 136 #define BP_GPIO_28_AL                           (28 | BP_ACTIVE_LOW)
 137 #define BP_GPIO_29_AH                           (29 | BP_ACTIVE_HIGH)
 138 #define BP_GPIO_29_AL                           (29 | BP_ACTIVE_LOW)
 139 #define BP_GPIO_30_AH                           (30 | BP_ACTIVE_HIGH)
 140 #define BP_GPIO_30_AL                           (30 | BP_ACTIVE_LOW)
 141 #define BP_GPIO_31_AH                           (31 | BP_ACTIVE_HIGH)
 142 #define BP_GPIO_31_AL                           (31 | BP_ACTIVE_LOW)
 143 #define BP_GPIO_32_AH                           (32 | BP_ACTIVE_HIGH)
 144 #define BP_GPIO_32_AL                           (32 | BP_ACTIVE_LOW)
 145 #define BP_GPIO_33_AH                           (33 | BP_ACTIVE_HIGH)
 146 #define BP_GPIO_33_AL                           (33 | BP_ACTIVE_LOW)
 147 #define BP_GPIO_34_AH                           (34 | BP_ACTIVE_HIGH)
 148 #define BP_GPIO_34_AL                           (34 | BP_ACTIVE_LOW)
 149 #define BP_GPIO_35_AH                           (35 | BP_ACTIVE_HIGH)
 150 #define BP_GPIO_35_AL                           (35 | BP_ACTIVE_LOW)
 151 #define BP_GPIO_36_AH                           (36 | BP_ACTIVE_HIGH)
 152 #define BP_GPIO_36_AL                           (36 | BP_ACTIVE_LOW)
 153
 154 /* Values for external interrupt assignments. */
 155 #define BP_EXT_INTR_0                           0
 156 #define BP_EXT_INTR_1                           1
 157 #define BP_EXT_INTR_2                           2
 158 #define BP_EXT_INTR_3                           3
 159
 160 /* Values for chip select assignments. */
 161 #define BP_CS_0                                 0
 162 #define BP_CS_1                                 1
 163 #define BP_CS_2                                 2
 164 #define BP_CS_3                                 3
 165
 166 /* Value for GPIO and external interrupt fields that are not used. */
 167 #define BP_NOT_DEFINED                          0xffff
 168 #define BP_HW_DEFINED                           0xfff0
 169 #define BP_UNEQUIPPED                           0xfff1
 170
 171 /* Maximum size of the board id string. */
 172 #define BP_BOARD_ID_LEN                         16
 173
 174 /* Maximum number of Ethernet MACs. */
 175 #define BP_MAX_ENET_MACS                        2
 176
 177 /* Maximum number of VoIP DSPs. */
 178 #define BP_MAX_VOIP_DSP                         2
 179
 180 /* Wireless Antenna Settings. */
 181 #define BP_WLAN_ANT_MAIN                        0
 182 #define BP_WLAN_ANT_AUX                         1
 183 #define BP_WLAN_ANT_BOTH                        3
 184
 185 #if !defined(__ASSEMBLER__)
 186
 187 /* Information about an Ethernet MAC.  If ucPhyType is BP_ENET_NO_PHY,
 188  * then the other fields are not valid.
 189  */
 190 typedef struct EthernetMacInfo
 191 {
 192     unsigned char ucPhyType;                    /* BP_ENET_xxx             */
 193     unsigned char ucPhyAddress;                 /* 0 to 31                 */
 194     unsigned short usGpioPhySpiSck;             /* GPIO pin or not defined */
 195     unsigned short usGpioPhySpiSs;              /* GPIO pin or not defined */
 196     unsigned short usGpioPhySpiMosi;            /* GPIO pin or not defined */
 197     unsigned short usGpioPhySpiMiso;            /* GPIO pin or not defined */
 198     unsigned short usGpioPhyReset;              /* GPIO pin or not defined (96348LV) */
 199     unsigned short numSwitchPorts;              /* Number of PHY ports */
 200     unsigned short usConfigType;                /* Configuration type */
 201     unsigned short usReverseMii;                /* Reverse MII */
 202 } ETHERNET_MAC_INFO, *PETHERNET_MAC_INFO;
 203
 204
 205 /* Information about VoIP DSPs.  If ucDspType is BP_VOIP_NO_DSP,
 206  * then the other fields are not valid.
 207  */
 208 typedef struct VoIPDspInfo
 209 {
 210     unsigned char  ucDspType;
 211     unsigned char  ucDspAddress;
 212     unsigned short usExtIntrVoip;
 213     unsigned short usGpioVoipReset;
 214     unsigned short usGpioVoipIntr;
 215     unsigned short usGpioLedVoip;
 216     unsigned short usCsVoip;
 217
 218 } VOIP_DSP_INFO;
 219
 220
 221 /**************************************************************************
 222  * Name       : BpSetBoardId
 223  *
 224  * Description: This function find the BOARD_PARAMETERS structure for the
 225  *              specified board id string and assigns it to a global, static
 226  *              variable.
 227  *
 228  * Parameters : [IN] pszBoardId - Board id string that is saved into NVRAM.
 229  *
 230  * Returns    : BP_SUCCESS - Success, value is returned.
 231  *              BP_BOARD_ID_NOT_FOUND - Error, board id input string does not
 232  *                  have a board parameters configuration record.
 233  ***************************************************************************/
 234 int BpSetBoardId( char *pszBoardId );
 235
 236 /**************************************************************************
 237  * Name       : BpGetBoardIds
 238  *
 239  * Description: This function returns all of the supported board id strings.
 240  *
 241  * Parameters : [OUT] pszBoardIds - Address of a buffer that the board id
 242  *                  strings are returned in.  Each id starts at BP_BOARD_ID_LEN
 243  *                  boundary.
 244  *              [IN] nBoardIdsSize - Number of BP_BOARD_ID_LEN elements that
 245  *                  were allocated in pszBoardIds.
 246  *
 247  * Returns    : Number of board id strings returned.
 248  ***************************************************************************/
 249 int BpGetBoardIds( char *pszBoardIds, int nBoardIdsSize );
 250
 251 /**************************************************************************
 252  * Name       : BpGetEthernetMacInfo
 253  *
 254  * Description: This function returns all of the supported board id strings.
 255  *
 256  * Parameters : [OUT] pEnetInfos - Address of an array of ETHERNET_MAC_INFO
 257  *                  buffers.
 258  *              [IN] nNumEnetInfos - Number of ETHERNET_MAC_INFO elements that
 259  *                  are pointed to by pEnetInfos.
 260  *
 261  * Returns    : BP_SUCCESS - Success, value is returned.
 262  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 263  ***************************************************************************/
 264 int BpGetEthernetMacInfo( PETHERNET_MAC_INFO pEnetInfos, int nNumEnetInfos );
 265
 266 /**************************************************************************
 267  * Name       : BpGetSdramSize
 268  *
 269  * Description: This function returns a constant that describees the board's
 270  *              SDRAM type and size.
 271  *
 272  * Parameters : [OUT] pulSdramSize - Address of short word that the SDRAM size
 273  *                  is returned in.
 274  *
 275  * Returns    : BP_SUCCESS - Success, value is returned.
 276  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 277  ***************************************************************************/
 278 int BpGetSdramSize( unsigned long *pulSdramSize );
 279
 280 /**************************************************************************
 281  * Name       : BpGetPsiSize
 282  *
 283  * Description: This function returns the persistent storage size in K bytes.
 284  *
 285  * Parameters : [OUT] pulPsiSize - Address of short word that the persistent
 286  *                  storage size is returned in.
 287  *
 288  * Returns    : BP_SUCCESS - Success, value is returned.
 289  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 290  ***************************************************************************/
 291 int BpGetPsiSize( unsigned long *pulPsiSize );
 292
 293 /**************************************************************************
 294  * Name       : BpGetRj11InnerOuterPairGpios
 295  *
 296  * Description: This function returns the GPIO pin assignments for changing
 297  *              between the RJ11 inner pair and RJ11 outer pair.
 298  *
 299  * Parameters : [OUT] pusInner - Address of short word that the RJ11 inner pair
 300  *                  GPIO pin is returned in.
 301  *              [OUT] pusOuter - Address of short word that the RJ11 outer pair
 302  *                  GPIO pin is returned in.
 303  *
 304  * Returns    : BP_SUCCESS - Success, values are returned.
 305  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 306  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 307  *                  for the board.
 308  ***************************************************************************/
 309 int BpGetRj11InnerOuterPairGpios( unsigned short *pusInner,
 310     unsigned short *pusOuter );
 311
 312 /**************************************************************************
 313  * Name       : BpGetPressAndHoldResetGpio
 314  *
 315  * Description: This function returns the GPIO pin assignment for the press
 316  *              and hold reset button.
 317  *
 318  * Parameters : [OUT] pusValue - Address of short word that the press and hold
 319  *                  reset button GPIO pin is returned in.
 320  *
 321  * Returns    : BP_SUCCESS - Success, value is returned.
 322  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 323  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 324  *                  for the board.
 325  ***************************************************************************/
 326 int BpGetPressAndHoldResetGpio( unsigned short *pusValue );
 327
 328 /**************************************************************************
 329  * Name       : BpGetVoipResetGpio
 330  *
 331  * Description: This function returns the GPIO pin assignment for the VOIP
 332  *              Reset operation.
 333  *
 334  * Parameters : [OUT] pusValue - Address of short word that the VOIP reset
 335  *                  GPIO pin is returned in.
 336  *              [IN] dspNum - Address of the DSP to query.
 337  *
 338  * Returns    : BP_SUCCESS - Success, value is returned.
 339  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 340  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 341  *                  for the board.
 342  ***************************************************************************/
 343 int BpGetVoipResetGpio( unsigned char dspNum, unsigned short *pusValue );
 344
 345 /**************************************************************************
 346  * Name       : BpGetVoipIntrGpio
 347  *
 348  * Description: This function returns the GPIO pin assignment for VoIP interrupt.
 349  *
 350  * Parameters : [OUT] pusValue - Address of short word that the VOIP interrupt
 351  *                  GPIO pin is returned in.
 352  *              [IN] dspNum - Address of the DSP to query.
 353  *
 354  * Returns    : BP_SUCCESS - Success, value is returned.
 355  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 356  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 357  *                  for the board.
 358  ***************************************************************************/
 359 int BpGetVoipIntrGpio( unsigned char dspNum, unsigned short *pusValue );
 360
 361 /**************************************************************************
 362  * Name       : BpGetPcmciaResetGpio
 363  *
 364  * Description: This function returns the GPIO pin assignment for the PCMCIA
 365  *              Reset operation.
 366  *
 367  * Parameters : [OUT] pusValue - Address of short word that the PCMCIA reset
 368  *                  GPIO pin is returned in.
 369  *
 370  * Returns    : BP_SUCCESS - Success, value is returned.
 371  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 372  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 373  *                  for the board.
 374  ***************************************************************************/
 375 int BpGetPcmciaResetGpio( unsigned short *pusValue );
 376
 377 /**************************************************************************
 378  * Name       : BpGetUartRtsCtsGpios
 379  *
 380  * Description: This function returns the GPIO pin assignments for RTS and CTS
 381  *              UART signals.
 382  *
 383  * Parameters : [OUT] pusRts - Address of short word that the UART RTS GPIO
 384  *                  pin is returned in.
 385  *              [OUT] pusCts - Address of short word that the UART CTS GPIO
 386  *                  pin is returned in.
 387  *
 388  * Returns    : BP_SUCCESS - Success, values are returned.
 389  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 390  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 391  *                  for the board.
 392  ***************************************************************************/
 393 int BpGetRtsCtsUartGpios( unsigned short *pusRts, unsigned short *pusCts );
 394
 395 /**************************************************************************
 396  * Name       : BpGetAdslLedGpio
 397  *
 398  * Description: This function returns the GPIO pin assignment for the ADSL
 399  *              LED.
 400  *
 401  * Parameters : [OUT] pusValue - Address of short word that the ADSL LED
 402  *                  GPIO pin is returned in.
 403  *
 404  * Returns    : BP_SUCCESS - Success, value is returned.
 405  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 406  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 407  *                  for the board.
 408  ***************************************************************************/
 409 int BpGetAdslLedGpio( unsigned short *pusValue );
 410
 411 /**************************************************************************
 412  * Name       : BpGetAdslFailLedGpio
 413  *
 414  * Description: This function returns the GPIO pin assignment for the ADSL
 415  *              LED that is used when there is a DSL connection failure.
 416  *
 417  * Parameters : [OUT] pusValue - Address of short word that the ADSL LED
 418  *                  GPIO pin is returned in.
 419  *
 420  * Returns    : BP_SUCCESS - Success, value is returned.
 421  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 422  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 423  *                  for the board.
 424  ***************************************************************************/
 425 int BpGetAdslFailLedGpio( unsigned short *pusValue );
 426
 427 /**************************************************************************
 428  * Name       : BpGetWirelessLedGpio
 429  *
 430  * Description: This function returns the GPIO pin assignment for the Wireless
 431  *              LED.
 432  *
 433  * Parameters : [OUT] pusValue - Address of short word that the Wireless LED
 434  *                  GPIO pin is returned in.
 435  *
 436  * Returns    : BP_SUCCESS - Success, value is returned.
 437  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 438  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 439  *                  for the board.
 440  ***************************************************************************/
 441 int BpGetWirelessLedGpio( unsigned short *pusValue );
 442
 443 /**************************************************************************
 444  * Name       : BpGetWirelessAntInUse
 445  *
 446  * Description: This function returns the antennas in use for wireless
 447  *
 448  * Parameters : [OUT] pusValue - Address of short word that the Wireless Antenna
 449  *                  is in use.
 450  *
 451  * Returns    : BP_SUCCESS - Success, value is returned.
 452  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 453  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 454  *                  for the board.
 455  ***************************************************************************/
 456 int BpGetWirelessAntInUse( unsigned short *pusValue );
 457
 458 /**************************************************************************
 459  * Name       : BpGetWirelessSesBtnGpio
 460  *
 461  * Description: This function returns the GPIO pin assignment for the Wireless
 462  *              Ses Button.
 463  *
 464  * Parameters : [OUT] pusValue - Address of short word that the Wireless Ses
 465  *                  Button GPIO pin is returned in.
 466  *
 467  * Returns    : BP_SUCCESS - Success, value is returned.
 468  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 469  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 470  *                  for the board.
 471  ***************************************************************************/
 472 int BpGetWirelessSesBtnGpio( unsigned short *pusValue );
 473
 474 /**************************************************************************
 475  * Name       : BpGetWirelessSesExtIntr
 476  *
 477  * Description: This function returns the external interrupt number for the
 478  *              Wireless Ses Button.
 479  *
 480  * Parameters : [OUT] pusValue - Address of short word that the Wireless Ses
 481  *                  external interrup is returned in.
 482  *
 483  * Returns    : BP_SUCCESS - Success, value is returned.
 484  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 485  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 486  *                  for the board.
 487  ***************************************************************************/
 488 int BpGetWirelessSesExtIntr( unsigned short *pusValue );
 489
 490 /**************************************************************************
 491  * Name       : BpGetWirelessSesLedGpio
 492  *
 493  * Description: This function returns the GPIO pin assignment for the Wireless
 494  *              Ses Led.
 495  *
 496  * Parameters : [OUT] pusValue - Address of short word that the Wireless Ses
 497  *                  Led GPIO pin is returned in.
 498  *
 499  * Returns    : BP_SUCCESS - Success, value is returned.
 500  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 501  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 502  *                  for the board.
 503  ***************************************************************************/
 504 int BpGetWirelessSesLedGpio( unsigned short *pusValue );
 505
 506 /**************************************************************************
 507  * Name       : BpGetUsbLedGpio
 508  *
 509  * Description: This function returns the GPIO pin assignment for the USB
 510  *              LED.
 511  *
 512  * Parameters : [OUT] pusValue - Address of short word that the USB LED
 513  *                  GPIO pin is returned in.
 514  *
 515  * Returns    : BP_SUCCESS - Success, value is returned.
 516  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 517  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 518  *                  for the board.
 519  ***************************************************************************/
 520 int BpGetUsbLedGpio( unsigned short *pusValue );
 521
 522 /**************************************************************************
 523  * Name       : BpGetHpnaLedGpio
 524  *
 525  * Description: This function returns the GPIO pin assignment for the HPNA
 526  *              LED.
 527  *
 528  * Parameters : [OUT] pusValue - Address of short word that the HPNA LED
 529  *                  GPIO pin is returned in.
 530  *
 531  * Returns    : BP_SUCCESS - Success, value is returned.
 532  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 533  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 534  *                  for the board.
 535  ***************************************************************************/
 536 int BpGetHpnaLedGpio( unsigned short *pusValue );
 537
 538 /**************************************************************************
 539  * Name       : BpGetWanDataLedGpio
 540  *
 541  * Description: This function returns the GPIO pin assignment for the WAN Data
 542  *              LED.
 543  *
 544  * Parameters : [OUT] pusValue - Address of short word that the WAN Data LED
 545  *                  GPIO pin is returned in.
 546  *
 547  * Returns    : BP_SUCCESS - Success, value is returned.
 548  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 549  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 550  *                  for the board.
 551  ***************************************************************************/
 552 int BpGetWanDataLedGpio( unsigned short *pusValue );
 553
 554 /**************************************************************************
 555  * Name       : BpGetPppLedGpio
 556  *
 557  * Description: This function returns the GPIO pin assignment for the PPP
 558  *              LED.
 559  *
 560  * Parameters : [OUT] pusValue - Address of short word that the PPP LED
 561  *                  GPIO pin is returned in.
 562  *
 563  * Returns    : BP_SUCCESS - Success, value is returned.
 564  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 565  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 566  *                  for the board.
 567  ***************************************************************************/
 568 int BpGetPppLedGpio( unsigned short *pusValue );
 569
 570 /**************************************************************************
 571  * Name       : BpGetPppFailLedGpio
 572  *
 573  * Description: This function returns the GPIO pin assignment for the PPP
 574  *              LED that is used when there is a PPP connection failure.
 575  *
 576  * Parameters : [OUT] pusValue - Address of short word that the PPP LED
 577  *                  GPIO pin is returned in.
 578  *
 579  * Returns    : BP_SUCCESS - Success, value is returned.
 580  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 581  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 582  *                  for the board.
 583  ***************************************************************************/
 584 int BpGetPppFailLedGpio( unsigned short *pusValue );
 585
 586 /**************************************************************************
 587  * Name       : BpGetVoipLedGpio
 588  *
 589  * Description: This function returns the GPIO pin assignment for the VOIP
 590  *              LED.
 591  *
 592  * Parameters : [OUT] pusValue - Address of short word that the VOIP LED
 593  *                  GPIO pin is returned in.
 594  *
 595  * Returns    : BP_SUCCESS - Success, value is returned.
 596  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 597  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 598  *                  for the board.
 599  ***************************************************************************/
 600 int BpGetVoipLedGpio( unsigned short *pusValue );
 601
 602 /**************************************************************************
 603  * Name       : BpGetBootloaderPowerOnLedGpio
 604  *
 605  * Description: This function returns the GPIO pin assignment for the power
 606  *              on LED that is set by the bootloader.
 607  *
 608  * Parameters : [OUT] pusValue - Address of short word that the alarm LED
 609  *                  GPIO pin is returned in.
 610  *
 611  * Returns    : BP_SUCCESS - Success, value is returned.
 612  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 613  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 614  *                  for the board.
 615  ***************************************************************************/
 616 int BpGetBootloaderPowerOnLedGpio( unsigned short *pusValue );
 617
 618 /**************************************************************************
 619  * Name       : BpGetBootloaderAlarmLedGpio
 620  *
 621  * Description: This function returns the GPIO pin assignment for the alarm
 622  *              LED that is set by the bootloader.
 623  *
 624  * Parameters : [OUT] pusValue - Address of short word that the alarm LED
 625  *                  GPIO pin is returned in.
 626  *
 627  * Returns    : BP_SUCCESS - Success, value is returned.
 628  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 629  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 630  *                  for the board.
 631  ***************************************************************************/
 632 int BpGetBootloaderAlarmLedGpio( unsigned short *pusValue );
 633
 634 /**************************************************************************
 635  * Name       : BpGetBootloaderResetCfgLedGpio
 636  *
 637  * Description: This function returns the GPIO pin assignment for the reset
 638  *              configuration LED that is set by the bootloader.
 639  *
 640  * Parameters : [OUT] pusValue - Address of short word that the reset
 641  *                  configuration LED GPIO pin is returned in.
 642  *
 643  * Returns    : BP_SUCCESS - Success, value is returned.
 644  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 645  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 646  *                  for the board.
 647  ***************************************************************************/
 648 int BpGetBootloaderResetCfgLedGpio( unsigned short *pusValue );
 649
 650 /**************************************************************************
 651  * Name       : BpGetBootloaderStopLedGpio
 652  *
 653  * Description: This function returns the GPIO pin assignment for the break
 654  *              into bootloader LED that is set by the bootloader.
 655  *
 656  * Parameters : [OUT] pusValue - Address of short word that the break into
 657  *                  bootloader LED GPIO pin is returned in.
 658  *
 659  * Returns    : BP_SUCCESS - Success, value is returned.
 660  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 661  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 662  *                  for the board.
 663  ***************************************************************************/
 664 int BpGetBootloaderStopLedGpio( unsigned short *pusValue );
 665
 666 /**************************************************************************
 667  * Name       : BpGetWirelessExtIntr
 668  *
 669  * Description: This function returns the Wireless external interrupt number.
 670  *
 671  * Parameters : [OUT] pulValue - Address of short word that the wireless
 672  *                  external interrupt number is returned in.
 673  *
 674  * Returns    : BP_SUCCESS - Success, value is returned.
 675  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 676  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 677  *                  for the board.
 678  ***************************************************************************/
 679 int BpGetWirelessExtIntr( unsigned long *pulValue );
 680
 681 /**************************************************************************
 682  * Name       : BpGetAdslDyingGaspExtIntr
 683  *
 684  * Description: This function returns the ADSL Dying Gasp external interrupt
 685  *              number.
 686  *
 687  * Parameters : [OUT] pulValue - Address of short word that the ADSL Dying Gasp
 688  *                  external interrupt number is returned in.
 689  *
 690  * Returns    : BP_SUCCESS - Success, value is returned.
 691  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 692  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 693  *                  for the board.
 694  ***************************************************************************/
 695 int BpGetAdslDyingGaspExtIntr( unsigned long *pulValue );
 696
 697 /**************************************************************************
 698  * Name       : BpGetVoipExtIntr
 699  *
 700  * Description: This function returns the VOIP external interrupt number.
 701  *
 702  * Parameters : [OUT] pulValue - Address of short word that the VOIP
 703  *                  external interrupt number is returned in.
 704  *              [IN] dspNum - Address of the DSP to query.
 705  *
 706  * Returns    : BP_SUCCESS - Success, value is returned.
 707  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 708  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 709  *                  for the board.
 710  ***************************************************************************/
 711 int BpGetVoipExtIntr( unsigned char dspNum, unsigned long *pulValue );
 712
 713 /**************************************************************************
 714  * Name       : BpGetHpnaExtIntr
 715  *
 716  * Description: This function returns the HPNA external interrupt number.
 717  *
 718  * Parameters : [OUT] pulValue - Address of short word that the HPNA
 719  *                  external interrupt number is returned in.
 720  *
 721  * Returns    : BP_SUCCESS - Success, value is returned.
 722  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 723  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 724  *                  for the board.
 725  ***************************************************************************/
 726 int BpGetHpnaExtIntr( unsigned long *pulValue );
 727
 728 /**************************************************************************
 729  * Name       : BpGetHpnaChipSelect
 730  *
 731  * Description: This function returns the HPNA chip select number.
 732  *
 733  * Parameters : [OUT] pulValue - Address of short word that the HPNA
 734  *                  chip select number is returned in.
 735  *
 736  * Returns    : BP_SUCCESS - Success, value is returned.
 737  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 738  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 739  *                  for the board.
 740  ***************************************************************************/
 741 int BpGetHpnaChipSelect( unsigned long *pulValue );
 742
 743 /**************************************************************************
 744  * Name       : BpGetVoipChipSelect
 745  *
 746  * Description: This function returns the VOIP chip select number.
 747  *
 748  * Parameters : [OUT] pulValue - Address of short word that the VOIP
 749  *                  chip select number is returned in.
 750  *              [IN] dspNum - Address of the DSP to query.
 751  *
 752  * Returns    : BP_SUCCESS - Success, value is returned.
 753  *              BP_BOARD_ID_NOT_SET - Error, BpSetBoardId has not been called.
 754  *              BP_VALUE_NOT_DEFINED - At least one return value is not defined
 755  *                  for the board.
 756  ***************************************************************************/
 757 int BpGetVoipChipSelect( unsigned char dspNum, unsigned long *pulValue );
 758
 759 #endif /* __ASSEMBLER__ */
 760
 761 #if __cplusplus
 762 }
 763 #endif
 764
 765 #endif /* _BOARDPARMS_H */
 766