* better
[mascara-docs.git] / i386 / linux-2.3.21 / drivers / net / rrunner.h
blob81acdf88b38f9310450792bc09fac85ffe0e7a73
1 #ifndef _RRUNNER_H_
2 #define _RRUNNER_H_
4 #include<linux/config.h>
6 #if ((BITS_PER_LONG != 32) && (BITS_PER_LONG != 64))
7 #error "BITS_PER_LONG not defined or not valid"
8 #endif
11 struct rr_regs {
13 u32 pad0[16];
15 u32 HostCtrl;
16 u32 LocalCtrl;
17 u32 Pc;
18 u32 BrkPt;
20 /* Timer increments every 0.97 micro-seconds (unsigned int) */
21 u32 Timer_Hi;
22 u32 Timer;
23 u32 TimerRef;
24 u32 PciState;
26 u32 Event;
27 u32 MbEvent;
29 u32 WinBase;
30 u32 WinData;
31 u32 RX_state;
32 u32 TX_state;
34 u32 Overhead;
35 u32 ExtIo;
37 u32 DmaWriteHostHi;
38 u32 DmaWriteHostLo;
40 u32 pad1[2];
42 u32 DmaReadHostHi;
43 u32 DmaReadHostLo;
45 u32 pad2;
47 u32 DmaReadLen;
48 u32 DmaWriteState;
50 u32 DmaWriteLcl;
51 u32 DmaWriteIPchecksum;
52 u32 DmaWriteLen;
53 u32 DmaReadState;
54 u32 DmaReadLcl;
55 u32 DmaReadIPchecksum;
56 u32 pad3;
58 u32 RxBase;
59 u32 RxPrd;
60 u32 RxCon;
62 u32 pad4;
64 u32 TxBase;
65 u32 TxPrd;
66 u32 TxCon;
68 u32 pad5;
70 u32 RxIndPro;
71 u32 RxIndCon;
72 u32 RxIndRef;
74 u32 pad6;
76 u32 TxIndPro;
77 u32 TxIndCon;
78 u32 TxIndRef;
80 u32 pad7[17];
82 u32 DrCmndPro;
83 u32 DrCmndCon;
84 u32 DrCmndRef;
86 u32 pad8;
88 u32 DwCmndPro;
89 u32 DwCmndCon;
90 u32 DwCmndRef;
92 u32 AssistState;
94 u32 DrDataPro;
95 u32 DrDataCon;
96 u32 DrDataRef;
98 u32 pad9;
100 u32 DwDataPro;
101 u32 DwDataCon;
102 u32 DwDataRef;
104 u32 pad10[33];
106 u32 EvtCon;
108 u32 pad11[5];
110 u32 TxPi;
111 u32 IpRxPi;
113 u32 pad11a[8];
115 u32 CmdRing[16];
117 /* The ULA is in two registers the high order two bytes of the first
118 * word contain the RunCode features.
119 * ula0 res res byte0 byte1
120 * ula1 byte2 byte3 byte4 byte5
122 u32 Ula0;
123 u32 Ula1;
125 u32 RxRingHi;
126 u32 RxRingLo;
128 u32 InfoPtrHi;
129 u32 InfoPtrLo;
131 u32 Mode;
133 u32 ConRetry;
134 u32 ConRetryTmr;
136 u32 ConTmout;
137 u32 CtatTmr;
139 u32 MaxRxRng;
141 u32 IntrTmr;
142 u32 TxDataMvTimeout;
143 u32 RxDataMvTimeout;
145 u32 EvtPrd;
146 u32 TraceIdx;
148 u32 Fail1;
149 u32 Fail2;
151 u32 DrvPrm;
153 u32 FilterLA;
155 u32 FwRev;
156 u32 FwRes1;
157 u32 FwRes2;
158 u32 FwRes3;
160 u32 WriteDmaThresh;
161 u32 ReadDmaThresh;
163 u32 pad12[325];
164 u32 Window[512];
168 * Host control register bits.
171 #define RR_INT 0x01
172 #define RR_CLEAR_INT 0x02
173 #define NO_SWAP 0x04000004
174 #define NO_SWAP1 0x00000004
175 #define PCI_RESET_NIC 0x08
176 #define HALT_NIC 0x10
177 #define SSTEP_NIC 0x20
178 #define MEM_READ_MULTI 0x40
179 #define NIC_HALTED 0x100
180 #define HALT_INST 0x200
181 #define PARITY_ERR 0x400
182 #define INVALID_INST_B 0x800
183 #define RR_REV_2 0x20000000
184 #define RR_REV_MASK 0xf0000000
187 * Local control register bits.
190 #define INTA_STATE 0x01
191 #define CLEAR_INTA 0x02
192 #define FAST_EEPROM_ACCESS 0x08
193 #define ENABLE_EXTRA_SRAM 0x100
194 #define ENABLE_EXTRA_DESC 0x200
195 #define ENABLE_PARITY 0x400
196 #define FORCE_DMA_PARITY_ERROR 0x800
197 #define ENABLE_EEPROM_WRITE 0x1000
198 #define ENABLE_DATA_CACHE 0x2000
199 #define SRAM_LO_PARITY_ERR 0x4000
200 #define SRAM_HI_PARITY_ERR 0x8000
203 * PCI state bits.
206 #define FORCE_PCI_RESET 0x01
207 #define PROVIDE_LENGTH 0x02
208 #define MASK_DMA_READ_MAX 0x1C
209 #define RBURST_DISABLE 0x00
210 #define RBURST_4 0x04
211 #define RBURST_16 0x08
212 #define RBURST_32 0x0C
213 #define RBURST_64 0x10
214 #define RBURST_128 0x14
215 #define RBURST_256 0x18
216 #define RBURST_1024 0x1C
217 #define MASK_DMA_WRITE_MAX 0xE0
218 #define WBURST_DISABLE 0x00
219 #define WBURST_4 0x20
220 #define WBURST_16 0x40
221 #define WBURST_32 0x60
222 #define WBURST_64 0x80
223 #define WBURST_128 0xa0
224 #define WBURST_256 0xc0
225 #define WBURST_1024 0xe0
226 #define MASK_MIN_DMA 0xFF00
227 #define FIFO_RETRY_ENABLE 0x10000
230 * Event register
233 #define DMA_WRITE_DONE 0x10000
234 #define DMA_READ_DONE 0x20000
235 #define DMA_WRITE_ERR 0x40000
236 #define DMA_READ_ERR 0x80000
239 * Receive state
241 * RoadRunner HIPPI Receive State Register controls and monitors the
242 * HIPPI receive interface in the NIC. Look at err bits when a HIPPI
243 * receive Error Event occurs.
246 #define ENABLE_NEW_CON 0x01
247 #define RESET_RECV 0x02
248 #define RECV_ALL 0x00
249 #define RECV_1K 0x20
250 #define RECV_2K 0x40
251 #define RECV_4K 0x60
252 #define RECV_8K 0x80
253 #define RECV_16K 0xa0
254 #define RECV_32K 0xc0
255 #define RECV_64K 0xe0
258 * Transmit status.
261 #define ENA_XMIT 0x01
262 #define PERM_CON 0x02
265 * DMA write state
268 #define RESET_DMA 0x01
269 #define NO_SWAP_DMA 0x02
270 #define DMA_ACTIVE 0x04
271 #define THRESH_MASK 0x1F
272 #define DMA_ERROR_MASK 0xff000000
275 * Gooddies stored in the ULA registers.
278 #define TRACE_ON_WHAT_BIT 0x00020000 /* Traces on */
279 #define ONEM_BUF_WHAT_BIT 0x00040000 /* 1Meg vs 256K */
280 #define CHAR_API_WHAT_BIT 0x00080000 /* Char API vs network only */
281 #define CMD_EVT_WHAT_BIT 0x00200000 /* Command event */
282 #define LONG_TX_WHAT_BIT 0x00400000
283 #define LONG_RX_WHAT_BIT 0x00800000
284 #define WHAT_BIT_MASK 0xFFFD0000 /* Feature bit mask */
287 * Mode status
290 #define EVENT_OVFL 0x80000000
291 #define FATAL_ERR 0x40000000
292 #define LOOP_BACK 0x01
293 #define MODE_PH 0x02
294 #define MODE_FP 0x00
295 #define PTR64BIT 0x04
296 #define PTR32BIT 0x00
297 #define PTR_WD_SWAP 0x08
298 #define PTR_WD_NOSWAP 0x00
299 #define POST_WARN_EVENT 0x10
300 #define ERR_TERM 0x20
301 #define DIRECT_CONN 0x40
302 #define NO_NIC_WATCHDOG 0x80
303 #define SWAP_DATA 0x100
304 #define SWAP_CONTROL 0x200
305 #define NIC_HALT_ON_ERR 0x400
306 #define NIC_NO_RESTART 0x800
307 #define HALF_DUP_TX 0x1000
308 #define HALF_DUP_RX 0x2000
312 * Error codes
315 /* Host Error Codes - values of fail1 */
316 #define ERR_UNKNOWN_MBOX 0x1001
317 #define ERR_UNKNOWN_CMD 0x1002
318 #define ERR_MAX_RING 0x1003
319 #define ERR_RING_CLOSED 0x1004
320 #define ERR_RING_OPEN 0x1005
321 /* Firmware internal errors */
322 #define ERR_EVENT_RING_FULL 0x01
323 #define ERR_DW_PEND_CMND_FULL 0x02
324 #define ERR_DR_PEND_CMND_FULL 0x03
325 #define ERR_DW_PEND_DATA_FULL 0x04
326 #define ERR_DR_PEND_DATA_FULL 0x05
327 #define ERR_ILLEGAL_JUMP 0x06
328 #define ERR_UNIMPLEMENTED 0x07
329 #define ERR_TX_INFO_FULL 0x08
330 #define ERR_RX_INFO_FULL 0x09
331 #define ERR_ILLEGAL_MODE 0x0A
332 #define ERR_MAIN_TIMEOUT 0x0B
333 #define ERR_EVENT_BITS 0x0C
334 #define ERR_UNPEND_FULL 0x0D
335 #define ERR_TIMER_QUEUE_FULL 0x0E
336 #define ERR_TIMER_QUEUE_EMPTY 0x0F
337 #define ERR_TIMER_NO_FREE 0x10
338 #define ERR_INTR_START 0x11
339 #define ERR_BAD_STARTUP 0x12
340 #define ERR_NO_PKT_END 0x13
341 #define ERR_HALTED_ON_ERR 0x14
342 /* Hardware NIC Errors */
343 #define ERR_WRITE_DMA 0x0101
344 #define ERR_READ_DMA 0x0102
345 #define ERR_EXT_SERIAL 0x0103
346 #define ERR_TX_INT_PARITY 0x0104
350 * Event definitions
353 #define EVT_RING_ENTRIES 64
354 #define EVT_RING_SIZE (EVT_RING_ENTRIES * sizeof(struct event))
356 struct event {
357 #ifdef __LITTLE_ENDIAN
358 u16 index;
359 u8 ring;
360 u8 code;
361 #else
362 u8 code;
363 u8 ring;
364 u16 index;
365 #endif
366 u32 timestamp;
370 * General Events
373 #define E_NIC_UP 0x01
374 #define E_WATCHDOG 0x02
376 #define E_STAT_UPD 0x04
377 #define E_INVAL_CMD 0x05
378 #define E_SET_CMD_CONS 0x06
379 #define E_LINK_ON 0x07
380 #define E_LINK_OFF 0x08
381 #define E_INTERN_ERR 0x09
382 #define E_HOST_ERR 0x0A
383 #define E_STATS_UPDATE 0x0B
384 #define E_REJECTING 0x0C
387 * Send Events
389 #define E_CON_REJ 0x13
390 #define E_CON_TMOUT 0x14
391 #define E_CON_NC_TMOUT 0x15 /* I , Connection No Campon Timeout */
392 #define E_DISC_ERR 0x16
393 #define E_INT_PRTY 0x17
394 #define E_TX_IDLE 0x18
395 #define E_TX_LINK_DROP 0x19
396 #define E_TX_INV_RNG 0x1A
397 #define E_TX_INV_BUF 0x1B
398 #define E_TX_INV_DSC 0x1C
401 * Destination Events
404 * General Receive events
406 #define E_VAL_RNG 0x20
407 #define E_RX_RNG_ENER 0x21
408 #define E_INV_RNG 0x22
409 #define E_RX_RNG_SPC 0x23
410 #define E_RX_RNG_OUT 0x24
411 #define E_PKT_DISCARD 0x25
412 #define E_INFO_EVT 0x27
415 * Data corrupted events
417 #define E_RX_PAR_ERR 0x2B
418 #define E_RX_LLRC_ERR 0x2C
419 #define E_IP_CKSM_ERR 0x2D
420 #define E_DTA_CKSM_ERR 0x2E
421 #define E_SHT_BST 0x2F
424 * Data lost events
426 #define E_LST_LNK_ERR 0x30
427 #define E_FLG_SYN_ERR 0x31
428 #define E_FRM_ERR 0x32
429 #define E_RX_IDLE 0x33
430 #define E_PKT_LN_ERR 0x34
431 #define E_STATE_ERR 0x35
432 #define E_UNEXP_DATA 0x3C
435 * Fatal events
437 #define E_RX_INV_BUF 0x36
438 #define E_RX_INV_DSC 0x37
439 #define E_RNG_BLK 0x38
442 * Warning events
444 #define E_RX_TO 0x39
445 #define E_BFR_SPC 0x3A
446 #define E_INV_ULP 0x3B
448 #define E_NOT_IMPLEMENTED 0x40
452 * Commands
455 #define CMD_RING_ENTRIES 16
457 struct cmd {
458 #ifdef __LITTLE_ENDIAN
459 u16 index;
460 u8 ring;
461 u8 code;
462 #else
463 u8 code;
464 u8 ring;
465 u16 index;
466 #endif
469 #define C_START_FW 0x01
470 #define C_UPD_STAT 0x02
471 #define C_WATCHDOG 0x05
472 #define C_DEL_RNG 0x09
473 #define C_NEW_RNG 0x0A
474 #define C_CONN 0x0D
478 * Mode bits
481 #define INTERRUPT 0x02
482 #define TX_IP_CKSUM 0x04
483 #define PACKET_END 0x08
484 #define PACKET_START 0x10
485 #define SAME_IFIELD 0x80
488 typedef struct {
489 #if (BITS_PER_LONG == 64)
490 u64 addrlo;
491 #else
492 u32 addrhi;
493 u32 addrlo;
494 #endif
495 } rraddr;
498 static inline void set_rraddr(rraddr *ra, volatile void *addr)
500 unsigned long baddr = virt_to_bus((void *)addr);
501 #if (BITS_PER_LONG == 64)
502 ra->addrlo = baddr;
503 #else
504 /* Don't bother setting zero every time */
505 ra->addrlo = baddr;
506 #endif
507 mb();
511 static inline void set_rxaddr(struct rr_regs *regs, volatile void *addr)
513 unsigned long baddr = virt_to_bus((void *)addr);
514 #if (BITS_PER_LONG == 64) && defined(__LITTLE_ENDIAN)
515 writel(baddr & 0xffffffff, &regs->RxRingHi);
516 writel(baddr >> 32, &regs->RxRingLo);
517 #elif (BITS_PER_LONG == 64)
518 writel(baddr >> 32, &regs->RxRingHi);
519 writel(baddr & 0xffffffff, &regs->RxRingLo);
520 #else
521 writel(0, &regs->RxRingHi);
522 writel(baddr, &regs->RxRingLo);
523 #endif
524 mb();
528 static inline void set_infoaddr(struct rr_regs *regs, volatile void *addr)
530 unsigned long baddr = virt_to_bus((void *)addr);
531 #if (BITS_PER_LONG == 64) && defined(__LITTLE_ENDIAN)
532 writel(baddr & 0xffffffff, &regs->InfoPtrHi);
533 writel(baddr >> 32, &regs->InfoPtrLo);
534 #elif (BITS_PER_LONG == 64)
535 writel(baddr >> 32, &regs->InfoPtrHi);
536 writel(baddr & 0xffffffff, &regs->InfoPtrLo);
537 #else
538 writel(0, &regs->InfoPtrHi);
539 writel(baddr, &regs->InfoPtrLo);
540 #endif
541 mb();
546 * TX ring
549 #ifdef CONFIG_ROADRUNNER_LARGE_RINGS
550 #define TX_RING_ENTRIES 32
551 #else
552 #define TX_RING_ENTRIES 16
553 #endif
554 #define TX_RING_SIZE (TX_RING_ENTRIES * sizeof(struct tx_desc))
556 struct tx_desc{
557 rraddr addr;
558 u32 res;
559 #ifdef __LITTLE_ENDIAN
560 u16 size;
561 u8 pad;
562 u8 mode;
563 #else
564 u8 mode;
565 u8 pad;
566 u16 size;
567 #endif
571 #ifdef CONFIG_ROADRUNNER_LARGE_RINGS
572 #define RX_RING_ENTRIES 32
573 #else
574 #define RX_RING_ENTRIES 16
575 #endif
576 #define RX_RING_SIZE (RX_RING_ENTRIES * sizeof(struct rx_desc))
578 struct rx_desc{
579 rraddr addr;
580 u32 res;
581 #ifdef __LITTLE_ENDIAN
582 u16 size;
583 u8 pad;
584 u8 mode;
585 #else
586 u8 mode;
587 u8 pad;
588 u16 size;
589 #endif
594 * ioctl's
597 #define SIOCRRPFW SIOCDEVPRIVATE /* put firmware */
598 #define SIOCRRGFW SIOCDEVPRIVATE+1 /* get firmware */
599 #define SIOCRRID SIOCDEVPRIVATE+2 /* identify */
602 struct seg_hdr {
603 u32 seg_start;
604 u32 seg_len;
605 u32 seg_eestart;
609 #define EEPROM_BASE 0x80000000
610 #define EEPROM_WORDS 8192
611 #define EEPROM_BYTES (EEPROM_WORDS * sizeof(u32))
613 struct eeprom_boot {
614 u32 key1;
615 u32 key2;
616 u32 sram_size;
617 struct seg_hdr loader;
618 u32 init_chksum;
619 u32 reserved1;
622 struct eeprom_manf {
623 u32 HeaderFmt;
624 u32 Firmware;
625 u32 BoardRevision;
626 u32 RoadrunnerRev;
627 char OpticsPart[8];
628 u32 OpticsRev;
629 u32 pad1;
630 char SramPart[8];
631 u32 SramRev;
632 u32 pad2;
633 char EepromPart[8];
634 u32 EepromRev;
635 u32 EepromSize;
636 char PalPart[8];
637 u32 PalRev;
638 u32 pad3;
639 char PalCodeFile[12];
640 u32 PalCodeRev;
641 char BoardULA[8];
642 char SerialNo[8];
643 char MfgDate[8];
644 char MfgTime[8];
645 char ModifyDate[8];
646 u32 ModCount;
647 u32 pad4[13];
651 struct eeprom_phase_info {
652 char phase1File[12];
653 u32 phase1Rev;
654 char phase1Date[8];
655 char phase2File[12];
656 u32 phase2Rev;
657 char phase2Date[8];
658 u32 reserved7[4];
661 struct eeprom_rncd_info {
662 u32 FwStart;
663 u32 FwRev;
664 char FwDate[8];
665 u32 AddrRunCodeSegs;
666 u32 FileNames;
667 char File[13][8];
671 /* Phase 1 region (starts are word offset 0x80) */
672 struct phase1_hdr{
673 u32 jump;
674 u32 noop;
675 struct seg_hdr phase2Seg;
678 struct eeprom {
679 struct eeprom_boot boot;
680 u32 pad1[8];
681 struct eeprom_manf manf;
682 struct eeprom_phase_info phase_info;
683 struct eeprom_rncd_info rncd_info;
684 u32 pad2[15];
685 u32 hdr_checksum;
686 struct phase1_hdr phase1;
690 struct rr_stats {
691 u32 NicTimeStamp;
692 u32 RngCreated;
693 u32 RngDeleted;
694 u32 IntrGen;
695 u32 NEvtOvfl;
696 u32 InvCmd;
697 u32 DmaReadErrs;
698 u32 DmaWriteErrs;
699 u32 StatUpdtT;
700 u32 StatUpdtC;
701 u32 WatchDog;
702 u32 Trace;
704 /* Serial HIPPI */
705 u32 LnkRdyEst;
706 u32 GLinkErr;
707 u32 AltFlgErr;
708 u32 OvhdBit8Sync;
709 u32 RmtSerPrtyErr;
710 u32 RmtParPrtyErr;
711 u32 RmtLoopBk;
712 u32 pad1;
714 /* HIPPI tx */
715 u32 ConEst;
716 u32 ConRejS;
717 u32 ConRetry;
718 u32 ConTmOut;
719 u32 SndConDiscon;
720 u32 SndParErr;
721 u32 PktSnt;
722 u32 pad2[2];
723 u32 ShFBstSnt;
724 u64 BytSent;
725 u32 TxTimeout;
726 u32 pad3[3];
728 /* HIPPI rx */
729 u32 ConAcc;
730 u32 ConRejdiPrty;
731 u32 ConRejd64b;
732 u32 ConRejdBuf;
733 u32 RxConDiscon;
734 u32 RxConNoData;
735 u32 PktRx;
736 u32 pad4[2];
737 u32 ShFBstRx;
738 u64 BytRx;
739 u32 RxParErr;
740 u32 RxLLRCerr;
741 u32 RxBstSZerr;
742 u32 RxStateErr;
743 u32 RxRdyErr;
744 u32 RxInvULP;
745 u32 RxSpcBuf;
746 u32 RxSpcDesc;
747 u32 RxRngSpc;
748 u32 RxRngFull;
749 u32 RxPktLenErr;
750 u32 RxCksmErr;
751 u32 RxPktDrp;
752 u32 RngLowSpc;
753 u32 RngDataClose;
754 u32 RxTimeout;
755 u32 RxIdle;
760 * This struct is shared with the NIC firmware.
762 struct ring_ctrl {
763 rraddr rngptr;
764 #ifdef __LITTLE_ENDIAN
765 u16 entries;
766 u8 pad;
767 u8 entry_size;
768 u16 pi;
769 u16 mode;
770 #else
771 u8 entry_size;
772 u8 pad;
773 u16 entries;
774 u16 mode;
775 u16 pi;
776 #endif
779 struct rr_info {
780 union {
781 struct rr_stats stats;
782 u32 stati[128];
783 } s;
784 struct ring_ctrl evt_ctrl;
785 struct ring_ctrl cmd_ctrl;
786 struct ring_ctrl tx_ctrl;
787 u8 pad[464];
788 u8 trace[3072];
792 * The linux structure for the RoadRunner.
794 * RX/TX descriptors are put first to make sure they are properly
795 * aligned and do not cross cache-line boundaries.
798 struct rr_private
800 struct rx_desc rx_ring[RX_RING_ENTRIES];
801 struct tx_desc tx_ring[TX_RING_ENTRIES];
802 struct event evt_ring[EVT_RING_ENTRIES];
803 struct sk_buff *rx_skbuff[RX_RING_ENTRIES];
804 struct sk_buff *tx_skbuff[TX_RING_ENTRIES];
805 struct rr_regs *regs; /* Register base */
806 struct ring_ctrl *rx_ctrl; /* Receive ring control */
807 struct rr_info *info; /* Shared info page */
808 struct net_device *next;
809 spinlock_t lock;
810 struct timer_list timer;
811 u32 cur_rx, cur_cmd, cur_evt;
812 u32 dirty_rx, dirty_tx;
813 u32 tx_full;
814 u32 fw_rev;
815 short fw_running;
816 char name[24]; /* The assigned name */
817 struct net_device_stats stats;
822 * Prototypes
824 static int rr_init(struct net_device *dev);
825 static int rr_init1(struct net_device *dev);
826 static void rr_interrupt(int irq, void *dev_id, struct pt_regs *regs);
828 static int rr_open(struct net_device *dev);
829 static int rr_start_xmit(struct sk_buff *skb, struct net_device *dev);
830 static int rr_close(struct net_device *dev);
831 static struct net_device_stats *rr_get_stats(struct net_device *dev);
832 static int rr_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
833 static unsigned int rr_read_eeprom(struct rr_private *rrpriv,
834 unsigned long offset,
835 unsigned char *buf,
836 unsigned long length);
837 static u32 rr_read_eeprom_word(struct rr_private *rrpriv, void * offset);
838 static int rr_load_firmware(struct net_device *dev);
840 #endif /* _RRUNNER_H_ */