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