4 Copyright 2003 Broadcom Corp. All Rights Reserved.
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.
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
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.
21 /**************************************************************************
22 * File Name : boardparms.h
24 * Description: This file contains definitions and function prototypes for
25 * the BCM63xx board parameter access functions.
27 * Updates : 07/14/2003 Created.
28 ***************************************************************************/
30 #if !defined(_BOARDPARMS_H)
35 #define BP_BOARD_ID_NOT_FOUND 1
36 #define BP_VALUE_NOT_DEFINED 2
37 #define BP_BOARD_ID_NOT_SET 3
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
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
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 */
62 /* Values for EthernetMacInfo Reverse MII. */
63 #define BP_ENET_NO_REVERSE_MII 0
64 #define BP_ENET_REVERSE_MII 1
66 /* Values for VoIPDSPInfo DSPType. */
67 #define BP_VOIP_NO_DSP 0
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)
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
156 /* Values for chip select assignments. */
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
167 /* Maximum size of the board id string. */
168 #define BP_BOARD_ID_LEN 16
170 /* Maximum number of Ethernet MACs. */
171 #define BP_MAX_ENET_MACS 2
173 /* Maximum number of VoIP DSPs. */
174 #define BP_MAX_VOIP_DSP 2
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
181 #if !defined(__ASSEMBLER__)
183 /* Information about an Ethernet MAC. If ucPhyType is BP_ENET_NO_PHY,
184 * then the other fields are not valid.
186 typedef struct EthernetMacInfo
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
;
201 /* Information about VoIP DSPs. If ucDspType is BP_VOIP_NO_DSP,
202 * then the other fields are not valid.
204 typedef struct VoIPDspInfo
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
;
217 /**************************************************************************
218 * Name : BpSetBoardId
220 * Description: This function find the BOARD_PARAMETERS structure for the
221 * specified board id string and assigns it to a global, static
224 * Parameters : [IN] pszBoardId - Board id string that is saved into NVRAM.
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
);
232 /**************************************************************************
233 * Name : BpGetBoardIds
235 * Description: This function returns all of the supported board id strings.
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
240 * [IN] nBoardIdsSize - Number of BP_BOARD_ID_LEN elements that
241 * were allocated in pszBoardIds.
243 * Returns : Number of board id strings returned.
244 ***************************************************************************/
245 int BpGetBoardIds( char *pszBoardIds
, int nBoardIdsSize
);
247 /**************************************************************************
248 * Name : BpGetEthernetMacInfo
250 * Description: This function returns all of the supported board id strings.
252 * Parameters : [OUT] pEnetInfos - Address of an array of ETHERNET_MAC_INFO
254 * [IN] nNumEnetInfos - Number of ETHERNET_MAC_INFO elements that
255 * are pointed to by pEnetInfos.
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
);
262 /**************************************************************************
263 * Name : BpGetSdramSize
265 * Description: This function returns a constant that describees the board's
266 * SDRAM type and size.
268 * Parameters : [OUT] pulSdramSize - Address of short word that the SDRAM size
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
);
276 /**************************************************************************
277 * Name : BpGetPsiSize
279 * Description: This function returns the persistent storage size in K bytes.
281 * Parameters : [OUT] pulPsiSize - Address of short word that the persistent
282 * storage size is returned in.
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
);
289 /**************************************************************************
290 * Name : BpGetRj11InnerOuterPairGpios
292 * Description: This function returns the GPIO pin assignments for changing
293 * between the RJ11 inner pair and RJ11 outer pair.
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.
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
304 ***************************************************************************/
305 int BpGetRj11InnerOuterPairGpios( unsigned short *pusInner
,
306 unsigned short *pusOuter
);
308 /**************************************************************************
309 * Name : BpGetPressAndHoldResetGpio
311 * Description: This function returns the GPIO pin assignment for the press
312 * and hold reset button.
314 * Parameters : [OUT] pusValue - Address of short word that the press and hold
315 * reset button GPIO pin is returned in.
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
321 ***************************************************************************/
322 int BpGetPressAndHoldResetGpio( unsigned short *pusValue
);
324 /**************************************************************************
325 * Name : BpGetVoipResetGpio
327 * Description: This function returns the GPIO pin assignment for the VOIP
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.
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
338 ***************************************************************************/
339 int BpGetVoipResetGpio( unsigned char dspNum
, unsigned short *pusValue
);
341 /**************************************************************************
342 * Name : BpGetVoipIntrGpio
344 * Description: This function returns the GPIO pin assignment for VoIP interrupt.
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.
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
354 ***************************************************************************/
355 int BpGetVoipIntrGpio( unsigned char dspNum
, unsigned short *pusValue
);
357 /**************************************************************************
358 * Name : BpGetPcmciaResetGpio
360 * Description: This function returns the GPIO pin assignment for the PCMCIA
363 * Parameters : [OUT] pusValue - Address of short word that the PCMCIA reset
364 * GPIO pin is returned in.
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
370 ***************************************************************************/
371 int BpGetPcmciaResetGpio( unsigned short *pusValue
);
373 /**************************************************************************
374 * Name : BpGetUartRtsCtsGpios
376 * Description: This function returns the GPIO pin assignments for RTS and CTS
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.
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
388 ***************************************************************************/
389 int BpGetRtsCtsUartGpios( unsigned short *pusRts
, unsigned short *pusCts
);
391 /**************************************************************************
392 * Name : BpGetAdslLedGpio
394 * Description: This function returns the GPIO pin assignment for the ADSL
397 * Parameters : [OUT] pusValue - Address of short word that the ADSL LED
398 * GPIO pin is returned in.
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
404 ***************************************************************************/
405 int BpGetAdslLedGpio( unsigned short *pusValue
);
407 /**************************************************************************
408 * Name : BpGetAdslFailLedGpio
410 * Description: This function returns the GPIO pin assignment for the ADSL
411 * LED that is used when there is a DSL connection failure.
413 * Parameters : [OUT] pusValue - Address of short word that the ADSL LED
414 * GPIO pin is returned in.
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
420 ***************************************************************************/
421 int BpGetAdslFailLedGpio( unsigned short *pusValue
);
423 /**************************************************************************
424 * Name : BpGetWirelessLedGpio
426 * Description: This function returns the GPIO pin assignment for the Wireless
429 * Parameters : [OUT] pusValue - Address of short word that the Wireless LED
430 * GPIO pin is returned in.
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
436 ***************************************************************************/
437 int BpGetWirelessLedGpio( unsigned short *pusValue
);
439 /**************************************************************************
440 * Name : BpGetWirelessAntInUse
442 * Description: This function returns the antennas in use for wireless
444 * Parameters : [OUT] pusValue - Address of short word that the Wireless Antenna
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
451 ***************************************************************************/
452 int BpGetWirelessAntInUse( unsigned short *pusValue
);
454 /**************************************************************************
455 * Name : BpGetWirelessSesBtnGpio
457 * Description: This function returns the GPIO pin assignment for the Wireless
460 * Parameters : [OUT] pusValue - Address of short word that the Wireless Ses
461 * Button GPIO pin is returned in.
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
467 ***************************************************************************/
468 int BpGetWirelessSesBtnGpio( unsigned short *pusValue
);
470 /**************************************************************************
471 * Name : BpGetWirelessSesExtIntr
473 * Description: This function returns the external interrupt number for the
474 * Wireless Ses Button.
476 * Parameters : [OUT] pusValue - Address of short word that the Wireless Ses
477 * external interrup is returned in.
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
483 ***************************************************************************/
484 int BpGetWirelessSesExtIntr( unsigned short *pusValue
);
486 /**************************************************************************
487 * Name : BpGetWirelessSesLedGpio
489 * Description: This function returns the GPIO pin assignment for the Wireless
492 * Parameters : [OUT] pusValue - Address of short word that the Wireless Ses
493 * Led GPIO pin is returned in.
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
499 ***************************************************************************/
500 int BpGetWirelessSesLedGpio( unsigned short *pusValue
);
502 /**************************************************************************
503 * Name : BpGetUsbLedGpio
505 * Description: This function returns the GPIO pin assignment for the USB
508 * Parameters : [OUT] pusValue - Address of short word that the USB LED
509 * GPIO pin is returned in.
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
515 ***************************************************************************/
516 int BpGetUsbLedGpio( unsigned short *pusValue
);
518 /**************************************************************************
519 * Name : BpGetHpnaLedGpio
521 * Description: This function returns the GPIO pin assignment for the HPNA
524 * Parameters : [OUT] pusValue - Address of short word that the HPNA LED
525 * GPIO pin is returned in.
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
531 ***************************************************************************/
532 int BpGetHpnaLedGpio( unsigned short *pusValue
);
534 /**************************************************************************
535 * Name : BpGetWanDataLedGpio
537 * Description: This function returns the GPIO pin assignment for the WAN Data
540 * Parameters : [OUT] pusValue - Address of short word that the WAN Data LED
541 * GPIO pin is returned in.
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
547 ***************************************************************************/
548 int BpGetWanDataLedGpio( unsigned short *pusValue
);
550 /**************************************************************************
551 * Name : BpGetPppLedGpio
553 * Description: This function returns the GPIO pin assignment for the PPP
556 * Parameters : [OUT] pusValue - Address of short word that the PPP LED
557 * GPIO pin is returned in.
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
563 ***************************************************************************/
564 int BpGetPppLedGpio( unsigned short *pusValue
);
566 /**************************************************************************
567 * Name : BpGetPppFailLedGpio
569 * Description: This function returns the GPIO pin assignment for the PPP
570 * LED that is used when there is a PPP connection failure.
572 * Parameters : [OUT] pusValue - Address of short word that the PPP LED
573 * GPIO pin is returned in.
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
579 ***************************************************************************/
580 int BpGetPppFailLedGpio( unsigned short *pusValue
);
582 /**************************************************************************
583 * Name : BpGetVoipLedGpio
585 * Description: This function returns the GPIO pin assignment for the VOIP
588 * Parameters : [OUT] pusValue - Address of short word that the VOIP LED
589 * GPIO pin is returned in.
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
595 ***************************************************************************/
596 int BpGetVoipLedGpio( unsigned short *pusValue
);
598 /**************************************************************************
599 * Name : BpGetBootloaderPowerOnLedGpio
601 * Description: This function returns the GPIO pin assignment for the power
602 * on LED that is set by the bootloader.
604 * Parameters : [OUT] pusValue - Address of short word that the alarm LED
605 * GPIO pin is returned in.
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
611 ***************************************************************************/
612 int BpGetBootloaderPowerOnLedGpio( unsigned short *pusValue
);
614 /**************************************************************************
615 * Name : BpGetBootloaderAlarmLedGpio
617 * Description: This function returns the GPIO pin assignment for the alarm
618 * LED that is set by the bootloader.
620 * Parameters : [OUT] pusValue - Address of short word that the alarm LED
621 * GPIO pin is returned in.
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
627 ***************************************************************************/
628 int BpGetBootloaderAlarmLedGpio( unsigned short *pusValue
);
630 /**************************************************************************
631 * Name : BpGetBootloaderResetCfgLedGpio
633 * Description: This function returns the GPIO pin assignment for the reset
634 * configuration LED that is set by the bootloader.
636 * Parameters : [OUT] pusValue - Address of short word that the reset
637 * configuration LED GPIO pin is returned in.
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
643 ***************************************************************************/
644 int BpGetBootloaderResetCfgLedGpio( unsigned short *pusValue
);
646 /**************************************************************************
647 * Name : BpGetBootloaderStopLedGpio
649 * Description: This function returns the GPIO pin assignment for the break
650 * into bootloader LED that is set by the bootloader.
652 * Parameters : [OUT] pusValue - Address of short word that the break into
653 * bootloader LED GPIO pin is returned in.
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
659 ***************************************************************************/
660 int BpGetBootloaderStopLedGpio( unsigned short *pusValue
);
662 /**************************************************************************
663 * Name : BpGetWirelessExtIntr
665 * Description: This function returns the Wireless external interrupt number.
667 * Parameters : [OUT] pulValue - Address of short word that the wireless
668 * external interrupt number is returned in.
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
674 ***************************************************************************/
675 int BpGetWirelessExtIntr( unsigned long *pulValue
);
677 /**************************************************************************
678 * Name : BpGetAdslDyingGaspExtIntr
680 * Description: This function returns the ADSL Dying Gasp external interrupt
683 * Parameters : [OUT] pulValue - Address of short word that the ADSL Dying Gasp
684 * external interrupt number is returned in.
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
690 ***************************************************************************/
691 int BpGetAdslDyingGaspExtIntr( unsigned long *pulValue
);
693 /**************************************************************************
694 * Name : BpGetVoipExtIntr
696 * Description: This function returns the VOIP external interrupt number.
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.
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
706 ***************************************************************************/
707 int BpGetVoipExtIntr( unsigned char dspNum
, unsigned long *pulValue
);
709 /**************************************************************************
710 * Name : BpGetHpnaExtIntr
712 * Description: This function returns the HPNA external interrupt number.
714 * Parameters : [OUT] pulValue - Address of short word that the HPNA
715 * external interrupt number is returned in.
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
721 ***************************************************************************/
722 int BpGetHpnaExtIntr( unsigned long *pulValue
);
724 /**************************************************************************
725 * Name : BpGetHpnaChipSelect
727 * Description: This function returns the HPNA chip select number.
729 * Parameters : [OUT] pulValue - Address of short word that the HPNA
730 * chip select number is returned in.
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
736 ***************************************************************************/
737 int BpGetHpnaChipSelect( unsigned long *pulValue
);
739 /**************************************************************************
740 * Name : BpGetVoipChipSelect
742 * Description: This function returns the VOIP chip select number.
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.
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
752 ***************************************************************************/
753 int BpGetVoipChipSelect( unsigned char dspNum
, unsigned long *pulValue
);
755 #endif /* __ASSEMBLER__ */
757 #endif /* _BOARDPARMS_H */