[pci] Add driver_data field to struct pci_device_id
[people/lynusvaz/gpxe.git] / src / drivers / net / phantom / phantom.c
1 /*
2  * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>.
3  * Copyright (C) 2008 NetXen, Inc.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License as
7  * published by the Free Software Foundation; either version 2 of the
8  * License, or any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18  */
19
20 #include <stdint.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <unistd.h>
24 #include <errno.h>
25 #include <assert.h>
26 #include <byteswap.h>
27 #include <gpxe/pci.h>
28 #include <gpxe/io.h>
29 #include <gpxe/malloc.h>
30 #include <gpxe/iobuf.h>
31 #include <gpxe/netdevice.h>
32 #include <gpxe/if_ether.h>
33 #include <gpxe/ethernet.h>
34 #include <gpxe/spi.h>
35 #include <gpxe/settings.h>
36 #include "phantom.h"
37
38 /**
39  * @file
40  *
41  * NetXen Phantom NICs
42  *
43  */
44
45 /** Maximum number of ports */
46 #define PHN_MAX_NUM_PORTS 4
47
48 /** Maximum time to wait for command PEG to initialise
49  *
50  * BUGxxxx
51  *
52  * The command PEG will currently report initialisation complete only
53  * when at least one PHY has detected a link (so that the global PHY
54  * clock can be set to 10G/1G as appropriate).  This can take a very,
55  * very long time.
56  *
57  * A future firmware revision should decouple PHY initialisation from
58  * firmware initialisation, at which point the command PEG will report
59  * initialisation complete much earlier, and this timeout can be
60  * reduced.
61  */
62 #define PHN_CMDPEG_INIT_TIMEOUT_SEC 50
63
64 /** Maximum time to wait for receive PEG to initialise */
65 #define PHN_RCVPEG_INIT_TIMEOUT_SEC 2
66
67 /** Maximum time to wait for firmware to accept a command */
68 #define PHN_ISSUE_CMD_TIMEOUT_MS 2000
69
70 /** Maximum time to wait for test memory */
71 #define PHN_TEST_MEM_TIMEOUT_MS 100
72
73 /** Maximum time to wait for CLP command to be issued */
74 #define PHN_CLP_CMD_TIMEOUT_MS 500
75
76 /** Link state poll frequency
77  *
78  * The link state will be checked once in every N calls to poll().
79  */
80 #define PHN_LINK_POLL_FREQUENCY 4096
81
82 /** Number of RX descriptors */
83 #define PHN_NUM_RDS 32
84
85 /** RX maximum fill level.  Must be strictly less than PHN_NUM_RDS. */
86 #define PHN_RDS_MAX_FILL 16
87
88 /** RX buffer size */
89 #define PHN_RX_BUFSIZE ( 32 /* max LL padding added by card */ + \
90                          ETH_FRAME_LEN )
91
92 /** Number of RX status descriptors */
93 #define PHN_NUM_SDS 32
94
95 /** Number of TX descriptors */
96 #define PHN_NUM_CDS 8
97
98 /** A Phantom descriptor ring set */
99 struct phantom_descriptor_rings {
100         /** RX descriptors */
101         struct phantom_rds rds[PHN_NUM_RDS];
102         /** RX status descriptors */
103         struct phantom_sds sds[PHN_NUM_SDS];
104         /** TX descriptors */
105         union phantom_cds cds[PHN_NUM_CDS];
106         /** TX consumer index */
107         volatile uint32_t cmd_cons;
108 };
109
110 /** RX context creation request and response buffers */
111 struct phantom_create_rx_ctx_rqrsp {
112         struct {
113                 struct nx_hostrq_rx_ctx_s rx_ctx;
114                 struct nx_hostrq_rds_ring_s rds;
115                 struct nx_hostrq_sds_ring_s sds;
116         } __unm_dma_aligned hostrq;
117         struct {
118                 struct nx_cardrsp_rx_ctx_s rx_ctx;
119                 struct nx_cardrsp_rds_ring_s rds;
120                 struct nx_cardrsp_sds_ring_s sds;
121         } __unm_dma_aligned cardrsp;
122 };
123
124 /** TX context creation request and response buffers */
125 struct phantom_create_tx_ctx_rqrsp {
126         struct {
127                 struct nx_hostrq_tx_ctx_s tx_ctx;
128         } __unm_dma_aligned hostrq;
129         struct {
130                 struct nx_cardrsp_tx_ctx_s tx_ctx;
131         } __unm_dma_aligned cardrsp;
132 };
133
134 /** A Phantom NIC */
135 struct phantom_nic {
136         /** BAR 0 */
137         void *bar0;
138         /** Current CRB window */
139         unsigned long crb_window;
140         /** CRB window access method */
141         unsigned long ( *crb_access ) ( struct phantom_nic *phantom,
142                                         unsigned long reg );
143
144
145         /** Port number */
146         unsigned int port;
147
148
149         /** RX context ID */
150         uint16_t rx_context_id;
151         /** RX descriptor producer CRB offset */
152         unsigned long rds_producer_crb;
153         /** RX status descriptor consumer CRB offset */
154         unsigned long sds_consumer_crb;
155
156         /** RX producer index */
157         unsigned int rds_producer_idx;
158         /** RX consumer index */
159         unsigned int rds_consumer_idx;
160         /** RX status consumer index */
161         unsigned int sds_consumer_idx;
162         /** RX I/O buffers */
163         struct io_buffer *rds_iobuf[PHN_RDS_MAX_FILL];
164
165
166         /** TX context ID */
167         uint16_t tx_context_id;
168         /** TX descriptor producer CRB offset */
169         unsigned long cds_producer_crb;
170
171         /** TX producer index */
172         unsigned int cds_producer_idx;
173         /** TX consumer index */
174         unsigned int cds_consumer_idx;
175         /** TX I/O buffers */
176         struct io_buffer *cds_iobuf[PHN_NUM_CDS];
177
178
179         /** Descriptor rings */
180         struct phantom_descriptor_rings *desc;
181
182
183         /** Last known link state */
184         uint32_t link_state;
185         /** Link state poll timer */
186         unsigned long link_poll_timer;
187
188
189         /** Non-volatile settings */
190         struct settings settings;
191 };
192
193 /***************************************************************************
194  *
195  * CRB register access
196  *
197  */
198
199 /**
200  * Prepare for access to CRB register via 128MB BAR
201  *
202  * @v phantom           Phantom NIC
203  * @v reg               Register offset within abstract address space
204  * @ret offset          Register offset within PCI BAR0
205  */
206 static unsigned long phantom_crb_access_128m ( struct phantom_nic *phantom,
207                                                unsigned long reg ) {
208         unsigned long offset = ( 0x6000000 + ( reg & 0x1ffffff ) );
209         uint32_t window = ( reg & 0x2000000 );
210         uint32_t verify_window;
211
212         if ( phantom->crb_window != window ) {
213
214                 /* Write to the CRB window register */
215                 writel ( window, phantom->bar0 + UNM_128M_CRB_WINDOW );
216
217                 /* Ensure that the write has reached the card */
218                 verify_window = readl ( phantom->bar0 + UNM_128M_CRB_WINDOW );
219                 assert ( verify_window == window );
220
221                 /* Record new window */
222                 phantom->crb_window = window;
223         }
224
225         return offset;
226 }
227
228 /**
229  * Prepare for access to CRB register via 32MB BAR
230  *
231  * @v phantom           Phantom NIC
232  * @v reg               Register offset within abstract address space
233  * @ret offset          Register offset within PCI BAR0
234  */
235 static unsigned long phantom_crb_access_32m ( struct phantom_nic *phantom,
236                                               unsigned long reg ) {
237         unsigned long offset = ( reg & 0x1ffffff );
238         uint32_t window = ( reg & 0x2000000 );
239         uint32_t verify_window;
240
241         if ( phantom->crb_window != window ) {
242
243                 /* Write to the CRB window register */
244                 writel ( window, phantom->bar0 + UNM_32M_CRB_WINDOW );
245
246                 /* Ensure that the write has reached the card */
247                 verify_window = readl ( phantom->bar0 + UNM_32M_CRB_WINDOW );
248                 assert ( verify_window == window );
249
250                 /* Record new window */
251                 phantom->crb_window = window;
252         }
253
254         return offset;
255 }
256
257 /**
258  * Prepare for access to CRB register via 2MB BAR
259  *
260  * @v phantom           Phantom NIC
261  * @v reg               Register offset within abstract address space
262  * @ret offset          Register offset within PCI BAR0
263  */
264 static unsigned long phantom_crb_access_2m ( struct phantom_nic *phantom,
265                                              unsigned long reg ) {
266         static const struct {
267                 uint8_t block;
268                 uint16_t window_hi;
269         } reg_window_hi[] = {
270                 { UNM_CRB_BLK_PCIE,     0x773 },
271                 { UNM_CRB_BLK_CAM,      0x416 },
272                 { UNM_CRB_BLK_ROMUSB,   0x421 },
273                 { UNM_CRB_BLK_TEST,     0x295 },
274                 { UNM_CRB_BLK_PEG_0,    0x340 },
275                 { UNM_CRB_BLK_PEG_1,    0x341 },
276                 { UNM_CRB_BLK_PEG_2,    0x342 },
277                 { UNM_CRB_BLK_PEG_3,    0x343 },
278                 { UNM_CRB_BLK_PEG_4,    0x34b },
279         };
280         unsigned int block = UNM_CRB_BLK ( reg );
281         unsigned long offset = UNM_CRB_OFFSET ( reg );
282         uint32_t window;
283         uint32_t verify_window;
284         unsigned int i;
285
286         for ( i = 0 ; i < ( sizeof ( reg_window_hi ) /
287                             sizeof ( reg_window_hi[0] ) ) ; i++ ) {
288
289                 if ( reg_window_hi[i].block != block )
290                         continue;
291
292                 window = ( ( reg_window_hi[i].window_hi << 20 ) |
293                            ( offset & 0x000f0000 ) );
294
295                 if ( phantom->crb_window != window ) {
296
297                         /* Write to the CRB window register */
298                         writel ( window, phantom->bar0 + UNM_2M_CRB_WINDOW );
299
300                         /* Ensure that the write has reached the card */
301                         verify_window = readl ( phantom->bar0 +
302                                                 UNM_2M_CRB_WINDOW );
303                         assert ( verify_window == window );
304
305                         /* Record new window */
306                         phantom->crb_window = window;
307                 }
308
309                 return ( 0x1e0000 + ( offset & 0xffff ) );
310         }
311
312         assert ( 0 );
313         return 0;
314 }
315
316 /**
317  * Read from Phantom CRB register
318  *
319  * @v phantom           Phantom NIC
320  * @v reg               Register offset within abstract address space
321  * @ret value           Register value
322  */
323 static uint32_t phantom_readl ( struct phantom_nic *phantom,
324                                 unsigned long reg ) {
325         unsigned long offset;
326
327         offset = phantom->crb_access ( phantom, reg );
328         return readl ( phantom->bar0 + offset );
329 }
330
331 /**
332  * Write to Phantom CRB register
333  *
334  * @v phantom           Phantom NIC
335  * @v value             Register value
336  * @v reg               Register offset within abstract address space
337  */
338 static void phantom_writel ( struct phantom_nic *phantom, uint32_t value,
339                              unsigned long reg ) {
340         unsigned long offset;
341
342         offset = phantom->crb_access ( phantom, reg );
343         writel ( value, phantom->bar0 + offset );
344 }
345
346 /**
347  * Write to Phantom CRB HI/LO register pair
348  *
349  * @v phantom           Phantom NIC
350  * @v value             Register value
351  * @v lo_offset         LO register offset within CRB
352  * @v hi_offset         HI register offset within CRB
353  */
354 static inline void phantom_write_hilo ( struct phantom_nic *phantom,
355                                         uint64_t value,
356                                         unsigned long lo_offset,
357                                         unsigned long hi_offset ) {
358         uint32_t lo = ( value & 0xffffffffUL );
359         uint32_t hi = ( value >> 32 );
360
361         phantom_writel ( phantom, lo, lo_offset );
362         phantom_writel ( phantom, hi, hi_offset );
363 }
364
365 /***************************************************************************
366  *
367  * Firmware message buffer access (for debug)
368  *
369  */
370
371 /**
372  * Read from Phantom test memory
373  *
374  * @v phantom           Phantom NIC
375  * @v offset            Offset within test memory
376  * @v buf               8-byte buffer to fill
377  * @ret rc              Return status code
378  */
379 static int phantom_read_test_mem_block ( struct phantom_nic *phantom,
380                                          unsigned long offset,
381                                          uint32_t buf[2] ) {
382         unsigned int retries;
383         uint32_t test_control;
384
385         phantom_write_hilo ( phantom, offset, UNM_TEST_ADDR_LO,
386                              UNM_TEST_ADDR_HI );
387         phantom_writel ( phantom, UNM_TEST_CONTROL_ENABLE, UNM_TEST_CONTROL );
388         phantom_writel ( phantom,
389                          ( UNM_TEST_CONTROL_ENABLE | UNM_TEST_CONTROL_START ),
390                          UNM_TEST_CONTROL );
391         
392         for ( retries = 0 ; retries < PHN_TEST_MEM_TIMEOUT_MS ; retries++ ) {
393                 test_control = phantom_readl ( phantom, UNM_TEST_CONTROL );
394                 if ( ( test_control & UNM_TEST_CONTROL_BUSY ) == 0 ) {
395                         buf[0] = phantom_readl ( phantom, UNM_TEST_RDDATA_LO );
396                         buf[1] = phantom_readl ( phantom, UNM_TEST_RDDATA_HI );
397                         return 0;
398                 }
399                 mdelay ( 1 );
400         }
401
402         DBGC ( phantom, "Phantom %p timed out waiting for test memory\n",
403                phantom );
404         return -ETIMEDOUT;
405 }
406
407 /**
408  * Read single byte from Phantom test memory
409  *
410  * @v phantom           Phantom NIC
411  * @v offset            Offset within test memory
412  * @ret byte            Byte read, or negative error
413  */
414 static int phantom_read_test_mem ( struct phantom_nic *phantom,
415                                    unsigned long offset ) {
416         static union {
417                 uint8_t bytes[8];
418                 uint32_t dwords[2];
419         } cache;
420         static unsigned long cache_offset = -1UL;
421         unsigned long sub_offset;
422         int rc;
423
424         sub_offset = ( offset & ( sizeof ( cache ) - 1 ) );
425         offset = ( offset & ~( sizeof ( cache ) - 1 ) );
426
427         if ( cache_offset != offset ) {
428                 if ( ( rc = phantom_read_test_mem_block ( phantom, offset,
429                                                           cache.dwords )) !=0 )
430                         return rc;
431                 cache_offset = offset;
432         }
433
434         return cache.bytes[sub_offset];
435 }
436
437 /**
438  * Dump Phantom firmware dmesg log
439  *
440  * @v phantom           Phantom NIC
441  * @v log               Log number
442  * @v max_lines         Maximum number of lines to show, or -1 to show all
443  * @ret rc              Return status code
444  */
445 static int phantom_dmesg ( struct phantom_nic *phantom, unsigned int log,
446                             unsigned int max_lines ) {
447         uint32_t head;
448         uint32_t tail;
449         uint32_t len;
450         uint32_t sig;
451         uint32_t offset;
452         int byte;
453
454         /* Optimise out for non-debug builds */
455         if ( ! DBG_LOG )
456                 return 0;
457
458         /* Locate log */
459         head = phantom_readl ( phantom, UNM_CAM_RAM_DMESG_HEAD ( log ) );
460         len = phantom_readl ( phantom, UNM_CAM_RAM_DMESG_LEN ( log ) );
461         tail = phantom_readl ( phantom, UNM_CAM_RAM_DMESG_TAIL ( log ) );
462         sig = phantom_readl ( phantom, UNM_CAM_RAM_DMESG_SIG ( log ) );
463         DBGC ( phantom, "Phantom %p firmware dmesg buffer %d (%08x-%08x)\n",
464                phantom, log, head, tail );
465         assert ( ( head & 0x07 ) == 0 );
466         if ( sig != UNM_CAM_RAM_DMESG_SIG_MAGIC ) {
467                 DBGC ( phantom, "Warning: bad signature %08x (want %08lx)\n",
468                        sig, UNM_CAM_RAM_DMESG_SIG_MAGIC );
469         }
470
471         /* Locate start of last (max_lines) lines */
472         for ( offset = tail ; offset > head ; offset-- ) {
473                 if ( ( byte = phantom_read_test_mem ( phantom,
474                                                       ( offset - 1 ) ) ) < 0 )
475                         return byte;
476                 if ( ( byte == '\n' ) && ( max_lines-- == 0 ) )
477                         break;
478         }
479
480         /* Print lines */
481         for ( ; offset < tail ; offset++ ) {
482                 if ( ( byte = phantom_read_test_mem ( phantom, offset ) ) < 0 )
483                         return byte;
484                 DBG ( "%c", byte );
485         }
486         DBG ( "\n" );
487         return 0;
488 }
489
490 /**
491  * Dump Phantom firmware dmesg logs
492  *
493  * @v phantom           Phantom NIC
494  * @v max_lines         Maximum number of lines to show, or -1 to show all
495  */
496 static void __attribute__ (( unused ))
497 phantom_dmesg_all ( struct phantom_nic *phantom, unsigned int max_lines ) {
498         unsigned int i;
499
500         for ( i = 0 ; i < UNM_CAM_RAM_NUM_DMESG_BUFFERS ; i++ )
501                 phantom_dmesg ( phantom, i, max_lines );
502 }
503
504 /***************************************************************************
505  *
506  * Firmware interface
507  *
508  */
509
510 /**
511  * Wait for firmware to accept command
512  *
513  * @v phantom           Phantom NIC
514  * @ret rc              Return status code
515  */
516 static int phantom_wait_for_cmd ( struct phantom_nic *phantom ) {
517         unsigned int retries;
518         uint32_t cdrp;
519
520         for ( retries = 0 ; retries < PHN_ISSUE_CMD_TIMEOUT_MS ; retries++ ) {
521                 mdelay ( 1 );
522                 cdrp = phantom_readl ( phantom, UNM_NIC_REG_NX_CDRP );
523                 if ( NX_CDRP_IS_RSP ( cdrp ) ) {
524                         switch ( NX_CDRP_FORM_RSP ( cdrp ) ) {
525                         case NX_CDRP_RSP_OK:
526                                 return 0;
527                         case NX_CDRP_RSP_FAIL:
528                                 return -EIO;
529                         case NX_CDRP_RSP_TIMEOUT:
530                                 return -ETIMEDOUT;
531                         default:
532                                 return -EPROTO;
533                         }
534                 }
535         }
536
537         DBGC ( phantom, "Phantom %p timed out waiting for firmware to accept "
538                "command\n", phantom );
539         return -ETIMEDOUT;
540 }
541
542 /**
543  * Issue command to firmware
544  *
545  * @v phantom           Phantom NIC
546  * @v command           Firmware command
547  * @v arg1              Argument 1
548  * @v arg2              Argument 2
549  * @v arg3              Argument 3
550  * @ret rc              Return status code
551  */
552 static int phantom_issue_cmd ( struct phantom_nic *phantom,
553                                uint32_t command, uint32_t arg1, uint32_t arg2,
554                                uint32_t arg3 ) {
555         uint32_t signature;
556         int rc;
557
558         /* Issue command */
559         signature = NX_CDRP_SIGNATURE_MAKE ( phantom->port,
560                                              NXHAL_VERSION );
561         DBGC2 ( phantom, "Phantom %p issuing command %08x (%08x, %08x, "
562                 "%08x)\n", phantom, command, arg1, arg2, arg3 );
563         phantom_writel ( phantom, signature, UNM_NIC_REG_NX_SIGN );
564         phantom_writel ( phantom, arg1, UNM_NIC_REG_NX_ARG1 );
565         phantom_writel ( phantom, arg2, UNM_NIC_REG_NX_ARG2 );
566         phantom_writel ( phantom, arg3, UNM_NIC_REG_NX_ARG3 );
567         phantom_writel ( phantom, NX_CDRP_FORM_CMD ( command ),
568                          UNM_NIC_REG_NX_CDRP );
569
570         /* Wait for command to be accepted */
571         if ( ( rc = phantom_wait_for_cmd ( phantom ) ) != 0 ) {
572                 DBGC ( phantom, "Phantom %p could not issue command: %s\n",
573                        phantom, strerror ( rc ) );
574                 return rc;
575         }
576
577         return 0;
578 }
579
580 /**
581  * Issue buffer-format command to firmware
582  *
583  * @v phantom           Phantom NIC
584  * @v command           Firmware command
585  * @v buffer            Buffer to pass to firmware
586  * @v len               Length of buffer
587  * @ret rc              Return status code
588  */
589 static int phantom_issue_buf_cmd ( struct phantom_nic *phantom,
590                                    uint32_t command, void *buffer,
591                                    size_t len ) {
592         uint64_t physaddr;
593
594         physaddr = virt_to_bus ( buffer );
595         return phantom_issue_cmd ( phantom, command, ( physaddr >> 32 ),
596                                    ( physaddr & 0xffffffffUL ), len );
597 }
598
599 /**
600  * Create Phantom RX context
601  *
602  * @v phantom           Phantom NIC
603  * @ret rc              Return status code
604  */
605 static int phantom_create_rx_ctx ( struct phantom_nic *phantom ) {
606         struct phantom_create_rx_ctx_rqrsp *buf;
607         int rc;
608
609         /* Allocate context creation buffer */
610         buf = malloc_dma ( sizeof ( *buf ), UNM_DMA_BUFFER_ALIGN );
611         if ( ! buf ) {
612                 rc = -ENOMEM;
613                 goto out;
614         }
615         memset ( buf, 0, sizeof ( *buf ) );
616         
617         /* Prepare request */
618         buf->hostrq.rx_ctx.host_rsp_dma_addr =
619                 cpu_to_le64 ( virt_to_bus ( &buf->cardrsp ) );
620         buf->hostrq.rx_ctx.capabilities[0] =
621                 cpu_to_le32 ( NX_CAP0_LEGACY_CONTEXT | NX_CAP0_LEGACY_MN );
622         buf->hostrq.rx_ctx.host_int_crb_mode =
623                 cpu_to_le32 ( NX_HOST_INT_CRB_MODE_SHARED );
624         buf->hostrq.rx_ctx.host_rds_crb_mode =
625                 cpu_to_le32 ( NX_HOST_RDS_CRB_MODE_UNIQUE );
626         buf->hostrq.rx_ctx.rds_ring_offset = cpu_to_le32 ( 0 );
627         buf->hostrq.rx_ctx.sds_ring_offset =
628                 cpu_to_le32 ( sizeof ( buf->hostrq.rds ) );
629         buf->hostrq.rx_ctx.num_rds_rings = cpu_to_le16 ( 1 );
630         buf->hostrq.rx_ctx.num_sds_rings = cpu_to_le16 ( 1 );
631         buf->hostrq.rds.host_phys_addr =
632                 cpu_to_le64 ( virt_to_bus ( phantom->desc->rds ) );
633         buf->hostrq.rds.buff_size = cpu_to_le64 ( PHN_RX_BUFSIZE );
634         buf->hostrq.rds.ring_size = cpu_to_le32 ( PHN_NUM_RDS );
635         buf->hostrq.rds.ring_kind = cpu_to_le32 ( NX_RDS_RING_TYPE_NORMAL );
636         buf->hostrq.sds.host_phys_addr =
637                 cpu_to_le64 ( virt_to_bus ( phantom->desc->sds ) );
638         buf->hostrq.sds.ring_size = cpu_to_le32 ( PHN_NUM_SDS );
639
640         DBGC ( phantom, "Phantom %p creating RX context\n", phantom );
641         DBGC2_HDA ( phantom, virt_to_bus ( &buf->hostrq ),
642                     &buf->hostrq, sizeof ( buf->hostrq ) );
643
644         /* Issue request */
645         if ( ( rc = phantom_issue_buf_cmd ( phantom,
646                                             NX_CDRP_CMD_CREATE_RX_CTX,
647                                             &buf->hostrq,
648                                             sizeof ( buf->hostrq ) ) ) != 0 ) {
649                 DBGC ( phantom, "Phantom %p could not create RX context: "
650                        "%s\n", phantom, strerror ( rc ) );
651                 DBGC ( phantom, "Request:\n" );
652                 DBGC_HDA ( phantom, virt_to_bus ( &buf->hostrq ),
653                            &buf->hostrq, sizeof ( buf->hostrq ) );
654                 DBGC ( phantom, "Response:\n" );
655                 DBGC_HDA ( phantom, virt_to_bus ( &buf->cardrsp ),
656                            &buf->cardrsp, sizeof ( buf->cardrsp ) );
657                 goto out;
658         }
659
660         /* Retrieve context parameters */
661         phantom->rx_context_id =
662                 le16_to_cpu ( buf->cardrsp.rx_ctx.context_id );
663         phantom->rds_producer_crb =
664                 ( UNM_CAM_RAM +
665                   le32_to_cpu ( buf->cardrsp.rds.host_producer_crb ));
666         phantom->sds_consumer_crb =
667                 ( UNM_CAM_RAM +
668                   le32_to_cpu ( buf->cardrsp.sds.host_consumer_crb ));
669
670         DBGC ( phantom, "Phantom %p created RX context (id %04x, port phys "
671                "%02x virt %02x)\n", phantom, phantom->rx_context_id,
672                buf->cardrsp.rx_ctx.phys_port, buf->cardrsp.rx_ctx.virt_port );
673         DBGC2_HDA ( phantom, virt_to_bus ( &buf->cardrsp ),
674                     &buf->cardrsp, sizeof ( buf->cardrsp ) );
675         DBGC ( phantom, "Phantom %p RDS producer CRB is %08lx\n",
676                phantom, phantom->rds_producer_crb );
677         DBGC ( phantom, "Phantom %p SDS consumer CRB is %08lx\n",
678                phantom, phantom->sds_consumer_crb );
679
680  out:
681         free_dma ( buf, sizeof ( *buf ) );
682         return rc;
683 }
684
685 /**
686  * Destroy Phantom RX context
687  *
688  * @v phantom           Phantom NIC
689  * @ret rc              Return status code
690  */
691 static void phantom_destroy_rx_ctx ( struct phantom_nic *phantom ) {
692         int rc;
693         
694         DBGC ( phantom, "Phantom %p destroying RX context (id %04x)\n",
695                phantom, phantom->rx_context_id );
696
697         /* Issue request */
698         if ( ( rc = phantom_issue_cmd ( phantom,
699                                         NX_CDRP_CMD_DESTROY_RX_CTX,
700                                         phantom->rx_context_id,
701                                         NX_DESTROY_CTX_RESET, 0 ) ) != 0 ) {
702                 DBGC ( phantom, "Phantom %p could not destroy RX context: "
703                        "%s\n", phantom, strerror ( rc ) );
704                 /* We're probably screwed */
705                 return;
706         }
707
708         /* Clear context parameters */
709         phantom->rx_context_id = 0;
710         phantom->rds_producer_crb = 0;
711         phantom->sds_consumer_crb = 0;
712
713         /* Reset software counters */
714         phantom->rds_producer_idx = 0;
715         phantom->rds_consumer_idx = 0;
716         phantom->sds_consumer_idx = 0;
717 }
718
719 /**
720  * Create Phantom TX context
721  *
722  * @v phantom           Phantom NIC
723  * @ret rc              Return status code
724  */
725 static int phantom_create_tx_ctx ( struct phantom_nic *phantom ) {
726         struct phantom_create_tx_ctx_rqrsp *buf;
727         int rc;
728
729         /* Allocate context creation buffer */
730         buf = malloc_dma ( sizeof ( *buf ), UNM_DMA_BUFFER_ALIGN );
731         if ( ! buf ) {
732                 rc = -ENOMEM;
733                 goto out;
734         }
735         memset ( buf, 0, sizeof ( *buf ) );
736
737         /* Prepare request */
738         buf->hostrq.tx_ctx.host_rsp_dma_addr =
739                 cpu_to_le64 ( virt_to_bus ( &buf->cardrsp ) );
740         buf->hostrq.tx_ctx.cmd_cons_dma_addr =
741                 cpu_to_le64 ( virt_to_bus ( &phantom->desc->cmd_cons ) );
742         buf->hostrq.tx_ctx.capabilities[0] =
743                 cpu_to_le32 ( NX_CAP0_LEGACY_CONTEXT | NX_CAP0_LEGACY_MN );
744         buf->hostrq.tx_ctx.host_int_crb_mode =
745                 cpu_to_le32 ( NX_HOST_INT_CRB_MODE_SHARED );
746         buf->hostrq.tx_ctx.cds_ring.host_phys_addr =
747                 cpu_to_le64 ( virt_to_bus ( phantom->desc->cds ) );
748         buf->hostrq.tx_ctx.cds_ring.ring_size = cpu_to_le32 ( PHN_NUM_CDS );
749
750         DBGC ( phantom, "Phantom %p creating TX context\n", phantom );
751         DBGC2_HDA ( phantom, virt_to_bus ( &buf->hostrq ),
752                     &buf->hostrq, sizeof ( buf->hostrq ) );
753
754         /* Issue request */
755         if ( ( rc = phantom_issue_buf_cmd ( phantom,
756                                             NX_CDRP_CMD_CREATE_TX_CTX,
757                                             &buf->hostrq,
758                                             sizeof ( buf->hostrq ) ) ) != 0 ) {
759                 DBGC ( phantom, "Phantom %p could not create TX context: "
760                        "%s\n", phantom, strerror ( rc ) );
761                 DBGC ( phantom, "Request:\n" );
762                 DBGC_HDA ( phantom, virt_to_bus ( &buf->hostrq ),
763                            &buf->hostrq, sizeof ( buf->hostrq ) );
764                 DBGC ( phantom, "Response:\n" );
765                 DBGC_HDA ( phantom, virt_to_bus ( &buf->cardrsp ),
766                            &buf->cardrsp, sizeof ( buf->cardrsp ) );
767                 goto out;
768         }
769
770         /* Retrieve context parameters */
771         phantom->tx_context_id =
772                 le16_to_cpu ( buf->cardrsp.tx_ctx.context_id );
773         phantom->cds_producer_crb =
774                 ( UNM_CAM_RAM +
775                   le32_to_cpu(buf->cardrsp.tx_ctx.cds_ring.host_producer_crb));
776
777         DBGC ( phantom, "Phantom %p created TX context (id %04x, port phys "
778                "%02x virt %02x)\n", phantom, phantom->tx_context_id,
779                buf->cardrsp.tx_ctx.phys_port, buf->cardrsp.tx_ctx.virt_port );
780         DBGC2_HDA ( phantom, virt_to_bus ( &buf->cardrsp ),
781                     &buf->cardrsp, sizeof ( buf->cardrsp ) );
782         DBGC ( phantom, "Phantom %p CDS producer CRB is %08lx\n",
783                phantom, phantom->cds_producer_crb );
784
785  out:
786         free_dma ( buf, sizeof ( *buf ) );
787         return rc;
788 }
789
790 /**
791  * Destroy Phantom TX context
792  *
793  * @v phantom           Phantom NIC
794  * @ret rc              Return status code
795  */
796 static void phantom_destroy_tx_ctx ( struct phantom_nic *phantom ) {
797         int rc;
798         
799         DBGC ( phantom, "Phantom %p destroying TX context (id %04x)\n",
800                phantom, phantom->tx_context_id );
801
802         /* Issue request */
803         if ( ( rc = phantom_issue_cmd ( phantom,
804                                         NX_CDRP_CMD_DESTROY_TX_CTX,
805                                         phantom->tx_context_id,
806                                         NX_DESTROY_CTX_RESET, 0 ) ) != 0 ) {
807                 DBGC ( phantom, "Phantom %p could not destroy TX context: "
808                        "%s\n", phantom, strerror ( rc ) );
809                 /* We're probably screwed */
810                 return;
811         }
812
813         /* Clear context parameters */
814         phantom->tx_context_id = 0;
815         phantom->cds_producer_crb = 0;
816
817         /* Reset software counters */
818         phantom->cds_producer_idx = 0;
819         phantom->cds_consumer_idx = 0;
820 }
821
822 /***************************************************************************
823  *
824  * Descriptor ring management
825  *
826  */
827
828 /**
829  * Allocate Phantom RX descriptor
830  *
831  * @v phantom           Phantom NIC
832  * @ret index           RX descriptor index, or negative error
833  */
834 static int phantom_alloc_rds ( struct phantom_nic *phantom ) {
835         unsigned int rds_producer_idx;
836         unsigned int next_rds_producer_idx;
837
838         /* Check for space in the ring.  RX descriptors are consumed
839          * out of order, but they are *read* by the hardware in strict
840          * order.  We maintain a pessimistic consumer index, which is
841          * guaranteed never to be an overestimate of the number of
842          * descriptors read by the hardware.
843          */
844         rds_producer_idx = phantom->rds_producer_idx;
845         next_rds_producer_idx = ( ( rds_producer_idx + 1 ) % PHN_NUM_RDS );
846         if ( next_rds_producer_idx == phantom->rds_consumer_idx ) {
847                 DBGC ( phantom, "Phantom %p RDS ring full (index %d not "
848                        "consumed)\n", phantom, next_rds_producer_idx );
849                 return -ENOBUFS;
850         }
851
852         return rds_producer_idx;
853 }
854
855 /**
856  * Post Phantom RX descriptor
857  *
858  * @v phantom           Phantom NIC
859  * @v rds               RX descriptor
860  */
861 static void phantom_post_rds ( struct phantom_nic *phantom,
862                                struct phantom_rds *rds ) {
863         unsigned int rds_producer_idx;
864         unsigned int next_rds_producer_idx;
865         struct phantom_rds *entry;
866
867         /* Copy descriptor to ring */
868         rds_producer_idx = phantom->rds_producer_idx;
869         entry = &phantom->desc->rds[rds_producer_idx];
870         memcpy ( entry, rds, sizeof ( *entry ) );
871         DBGC2 ( phantom, "Phantom %p posting RDS %ld (slot %d):\n",
872                 phantom, NX_GET ( rds, handle ), rds_producer_idx );
873         DBGC2_HDA ( phantom, virt_to_bus ( entry ), entry, sizeof ( *entry ) );
874
875         /* Update producer index */
876         next_rds_producer_idx = ( ( rds_producer_idx + 1 ) % PHN_NUM_RDS );
877         phantom->rds_producer_idx = next_rds_producer_idx;
878         wmb();
879         phantom_writel ( phantom, phantom->rds_producer_idx,
880                          phantom->rds_producer_crb );
881 }
882
883 /**
884  * Allocate Phantom TX descriptor
885  *
886  * @v phantom           Phantom NIC
887  * @ret index           TX descriptor index, or negative error
888  */
889 static int phantom_alloc_cds ( struct phantom_nic *phantom ) {
890         unsigned int cds_producer_idx;
891         unsigned int next_cds_producer_idx;
892
893         /* Check for space in the ring.  TX descriptors are consumed
894          * in strict order, so we just check for a collision against
895          * the consumer index.
896          */
897         cds_producer_idx = phantom->cds_producer_idx;
898         next_cds_producer_idx = ( ( cds_producer_idx + 1 ) % PHN_NUM_CDS );
899         if ( next_cds_producer_idx == phantom->cds_consumer_idx ) {
900                 DBGC ( phantom, "Phantom %p CDS ring full (index %d not "
901                        "consumed)\n", phantom, next_cds_producer_idx );
902                 return -ENOBUFS;
903         }
904
905         return cds_producer_idx;
906 }
907
908 /**
909  * Post Phantom TX descriptor
910  *
911  * @v phantom           Phantom NIC
912  * @v cds               TX descriptor
913  */
914 static void phantom_post_cds ( struct phantom_nic *phantom,
915                                union phantom_cds *cds ) {
916         unsigned int cds_producer_idx;
917         unsigned int next_cds_producer_idx;
918         union phantom_cds *entry;
919
920         /* Copy descriptor to ring */
921         cds_producer_idx = phantom->cds_producer_idx;
922         entry = &phantom->desc->cds[cds_producer_idx];
923         memcpy ( entry, cds, sizeof ( *entry ) );
924         DBGC2 ( phantom, "Phantom %p posting CDS %d:\n",
925                 phantom, cds_producer_idx );
926         DBGC2_HDA ( phantom, virt_to_bus ( entry ), entry, sizeof ( *entry ) );
927
928         /* Update producer index */
929         next_cds_producer_idx = ( ( cds_producer_idx + 1 ) % PHN_NUM_CDS );
930         phantom->cds_producer_idx = next_cds_producer_idx;
931         wmb();
932         phantom_writel ( phantom, phantom->cds_producer_idx,
933                          phantom->cds_producer_crb );
934 }
935
936 /***************************************************************************
937  *
938  * MAC address management
939  *
940  */
941
942 /**
943  * Add/remove MAC address
944  *
945  * @v phantom           Phantom NIC
946  * @v ll_addr           MAC address to add or remove
947  * @v opcode            MAC request opcode
948  * @ret rc              Return status code
949  */
950 static int phantom_update_macaddr ( struct phantom_nic *phantom,
951                                     const uint8_t *ll_addr,
952                                     unsigned int opcode ) {
953         union phantom_cds cds;
954         int index;
955
956         /* Get descriptor ring entry */
957         index = phantom_alloc_cds ( phantom );
958         if ( index < 0 )
959                 return index;
960
961         /* Fill descriptor ring entry */
962         memset ( &cds, 0, sizeof ( cds ) );
963         NX_FILL_1 ( &cds, 0,
964                     nic_request.common.opcode, UNM_NIC_REQUEST );
965         NX_FILL_2 ( &cds, 1,
966                     nic_request.header.opcode, UNM_MAC_EVENT,
967                     nic_request.header.context_id, phantom->port );
968         NX_FILL_7 ( &cds, 2,
969                     nic_request.body.mac_request.opcode, opcode,
970                     nic_request.body.mac_request.mac_addr_0, ll_addr[0],
971                     nic_request.body.mac_request.mac_addr_1, ll_addr[1],
972                     nic_request.body.mac_request.mac_addr_2, ll_addr[2],
973                     nic_request.body.mac_request.mac_addr_3, ll_addr[3],
974                     nic_request.body.mac_request.mac_addr_4, ll_addr[4],
975                     nic_request.body.mac_request.mac_addr_5, ll_addr[5] );
976
977         /* Post descriptor */
978         phantom_post_cds ( phantom, &cds );
979
980         return 0;
981 }
982
983 /**
984  * Add MAC address
985  *
986  * @v phantom           Phantom NIC
987  * @v ll_addr           MAC address to add or remove
988  * @ret rc              Return status code
989  */
990 static inline int phantom_add_macaddr ( struct phantom_nic *phantom,
991                                         const uint8_t *ll_addr ) {
992
993         DBGC ( phantom, "Phantom %p adding MAC address %s\n",
994                phantom, eth_ntoa ( ll_addr ) );
995
996         return phantom_update_macaddr ( phantom, ll_addr, UNM_MAC_ADD );
997 }
998
999 /**
1000  * Remove MAC address
1001  *
1002  * @v phantom           Phantom NIC
1003  * @v ll_addr           MAC address to add or remove
1004  * @ret rc              Return status code
1005  */
1006 static inline int phantom_del_macaddr ( struct phantom_nic *phantom,
1007                                         const uint8_t *ll_addr ) {
1008
1009         DBGC ( phantom, "Phantom %p removing MAC address %s\n",
1010                phantom, eth_ntoa ( ll_addr ) );
1011
1012         return phantom_update_macaddr ( phantom, ll_addr, UNM_MAC_DEL );
1013 }
1014
1015 /***************************************************************************
1016  *
1017  * Link state detection
1018  *
1019  */
1020
1021 /**
1022  * Poll link state
1023  *
1024  * @v netdev            Network device
1025  */
1026 static void phantom_poll_link_state ( struct net_device *netdev ) {
1027         struct phantom_nic *phantom = netdev_priv ( netdev );
1028         uint32_t xg_state_p3;
1029         unsigned int link;
1030
1031         /* Read link state */
1032         xg_state_p3 = phantom_readl ( phantom, UNM_NIC_REG_XG_STATE_P3 );
1033
1034         /* If there is no change, do nothing */
1035         if ( phantom->link_state == xg_state_p3 )
1036                 return;
1037
1038         /* Record new link state */
1039         DBGC ( phantom, "Phantom %p new link state %08x (was %08x)\n",
1040                phantom, xg_state_p3, phantom->link_state );
1041         phantom->link_state = xg_state_p3;
1042
1043         /* Indicate link state to gPXE */
1044         link = UNM_NIC_REG_XG_STATE_P3_LINK ( phantom->port,
1045                                               phantom->link_state );
1046         switch ( link ) {
1047         case UNM_NIC_REG_XG_STATE_P3_LINK_UP:
1048                 DBGC ( phantom, "Phantom %p link is up\n", phantom );
1049                 netdev_link_up ( netdev );
1050                 break;
1051         case UNM_NIC_REG_XG_STATE_P3_LINK_DOWN:
1052                 DBGC ( phantom, "Phantom %p link is down\n", phantom );
1053                 netdev_link_down ( netdev );
1054                 break;
1055         default:
1056                 DBGC ( phantom, "Phantom %p bad link state %d\n",
1057                        phantom, link );
1058                 break;
1059         }
1060 }
1061
1062 /***************************************************************************
1063  *
1064  * Main driver body
1065  *
1066  */
1067
1068 /**
1069  * Refill descriptor ring
1070  *
1071  * @v netdev            Net device
1072  */
1073 static void phantom_refill_rx_ring ( struct net_device *netdev ) {
1074         struct phantom_nic *phantom = netdev_priv ( netdev );
1075         struct io_buffer *iobuf;
1076         struct phantom_rds rds;
1077         unsigned int handle;
1078         int index;
1079
1080         for ( handle = 0 ; handle < PHN_RDS_MAX_FILL ; handle++ ) {
1081
1082                 /* Skip this index if the descriptor has not yet been
1083                  * consumed.
1084                  */
1085                 if ( phantom->rds_iobuf[handle] != NULL )
1086                         continue;
1087
1088                 /* Allocate descriptor ring entry */
1089                 index = phantom_alloc_rds ( phantom );
1090                 assert ( PHN_RDS_MAX_FILL < PHN_NUM_RDS );
1091                 assert ( index >= 0 ); /* Guaranteed by MAX_FILL < NUM_RDS ) */
1092
1093                 /* Try to allocate an I/O buffer */
1094                 iobuf = alloc_iob ( PHN_RX_BUFSIZE );
1095                 if ( ! iobuf ) {
1096                         /* Failure is non-fatal; we will retry later */
1097                         netdev_rx_err ( netdev, NULL, -ENOMEM );
1098                         break;
1099                 }
1100
1101                 /* Fill descriptor ring entry */
1102                 memset ( &rds, 0, sizeof ( rds ) );
1103                 NX_FILL_2 ( &rds, 0,
1104                             handle, handle,
1105                             length, iob_len ( iobuf ) );
1106                 NX_FILL_1 ( &rds, 1,
1107                             dma_addr, virt_to_bus ( iobuf->data ) );
1108
1109                 /* Record I/O buffer */
1110                 assert ( phantom->rds_iobuf[handle] == NULL );
1111                 phantom->rds_iobuf[handle] = iobuf;
1112
1113                 /* Post descriptor */
1114                 phantom_post_rds ( phantom, &rds );
1115         }
1116 }
1117
1118 /**
1119  * Open NIC
1120  *
1121  * @v netdev            Net device
1122  * @ret rc              Return status code
1123  */
1124 static int phantom_open ( struct net_device *netdev ) {
1125         struct phantom_nic *phantom = netdev_priv ( netdev );
1126         int rc;
1127
1128         /* Allocate and zero descriptor rings */
1129         phantom->desc = malloc_dma ( sizeof ( *(phantom->desc) ),
1130                                           UNM_DMA_BUFFER_ALIGN );
1131         if ( ! phantom->desc ) {
1132                 rc = -ENOMEM;
1133                 goto err_alloc_desc;
1134         }
1135         memset ( phantom->desc, 0, sizeof ( *(phantom->desc) ) );
1136
1137         /* Create RX context */
1138         if ( ( rc = phantom_create_rx_ctx ( phantom ) ) != 0 )
1139                 goto err_create_rx_ctx;
1140
1141         /* Create TX context */
1142         if ( ( rc = phantom_create_tx_ctx ( phantom ) ) != 0 )
1143                 goto err_create_tx_ctx;
1144
1145         /* Fill the RX descriptor ring */
1146         phantom_refill_rx_ring ( netdev );
1147
1148         /* Add MAC addresses
1149          *
1150          * BUG5583
1151          *
1152          * We would like to be able to enable receiving all multicast
1153          * packets (or, failing that, promiscuous mode), but the
1154          * firmware doesn't currently support this.
1155          */
1156         if ( ( rc = phantom_add_macaddr ( phantom,
1157                                    netdev->ll_protocol->ll_broadcast ) ) != 0 )
1158                 goto err_add_macaddr_broadcast;
1159         if ( ( rc = phantom_add_macaddr ( phantom,
1160                                           netdev->ll_addr ) ) != 0 )
1161                 goto err_add_macaddr_unicast;
1162
1163         return 0;
1164
1165         phantom_del_macaddr ( phantom, netdev->ll_addr );
1166  err_add_macaddr_unicast:
1167         phantom_del_macaddr ( phantom,
1168                               netdev->ll_protocol->ll_broadcast );
1169  err_add_macaddr_broadcast:
1170         phantom_destroy_tx_ctx ( phantom );
1171  err_create_tx_ctx:
1172         phantom_destroy_rx_ctx ( phantom );
1173  err_create_rx_ctx:
1174         free_dma ( phantom->desc, sizeof ( *(phantom->desc) ) );
1175         phantom->desc = NULL;
1176  err_alloc_desc:
1177         return rc;
1178 }
1179
1180 /**
1181  * Close NIC
1182  *
1183  * @v netdev            Net device
1184  */
1185 static void phantom_close ( struct net_device *netdev ) {
1186         struct phantom_nic *phantom = netdev_priv ( netdev );
1187         struct io_buffer *iobuf;
1188         unsigned int i;
1189
1190         /* Shut down the port */
1191         phantom_del_macaddr ( phantom, netdev->ll_addr );
1192         phantom_del_macaddr ( phantom,
1193                               netdev->ll_protocol->ll_broadcast );
1194         phantom_destroy_tx_ctx ( phantom );
1195         phantom_destroy_rx_ctx ( phantom );
1196         free_dma ( phantom->desc, sizeof ( *(phantom->desc) ) );
1197         phantom->desc = NULL;
1198
1199         /* Flush any uncompleted descriptors */
1200         for ( i = 0 ; i < PHN_RDS_MAX_FILL ; i++ ) {
1201                 iobuf = phantom->rds_iobuf[i];
1202                 if ( iobuf ) {
1203                         free_iob ( iobuf );
1204                         phantom->rds_iobuf[i] = NULL;
1205                 }
1206         }
1207         for ( i = 0 ; i < PHN_NUM_CDS ; i++ ) {
1208                 iobuf = phantom->cds_iobuf[i];
1209                 if ( iobuf ) {
1210                         netdev_tx_complete_err ( netdev, iobuf, -ECANCELED );
1211                         phantom->cds_iobuf[i] = NULL;
1212                 }
1213         }
1214 }
1215
1216 /** 
1217  * Transmit packet
1218  *
1219  * @v netdev    Network device
1220  * @v iobuf     I/O buffer
1221  * @ret rc      Return status code
1222  */
1223 static int phantom_transmit ( struct net_device *netdev,
1224                               struct io_buffer *iobuf ) {
1225         struct phantom_nic *phantom = netdev_priv ( netdev );
1226         union phantom_cds cds;
1227         int index;
1228
1229         /* Get descriptor ring entry */
1230         index = phantom_alloc_cds ( phantom );
1231         if ( index < 0 )
1232                 return index;
1233
1234         /* Fill descriptor ring entry */
1235         memset ( &cds, 0, sizeof ( cds ) );
1236         NX_FILL_3 ( &cds, 0,
1237                     tx.opcode, UNM_TX_ETHER_PKT,
1238                     tx.num_buffers, 1,
1239                     tx.length, iob_len ( iobuf ) );
1240         NX_FILL_2 ( &cds, 2,
1241                     tx.port, phantom->port,
1242                     tx.context_id, phantom->port );
1243         NX_FILL_1 ( &cds, 4,
1244                     tx.buffer1_dma_addr, virt_to_bus ( iobuf->data ) );
1245         NX_FILL_1 ( &cds, 5,
1246                     tx.buffer1_length, iob_len ( iobuf ) );
1247
1248         /* Record I/O buffer */
1249         assert ( phantom->cds_iobuf[index] == NULL );
1250         phantom->cds_iobuf[index] = iobuf;
1251
1252         /* Post descriptor */
1253         phantom_post_cds ( phantom, &cds );
1254
1255         return 0;
1256 }
1257
1258 /**
1259  * Poll for received packets
1260  *
1261  * @v netdev    Network device
1262  */
1263 static void phantom_poll ( struct net_device *netdev ) {
1264         struct phantom_nic *phantom = netdev_priv ( netdev );
1265         struct io_buffer *iobuf;
1266         unsigned int cds_consumer_idx;
1267         unsigned int raw_new_cds_consumer_idx;
1268         unsigned int new_cds_consumer_idx;
1269         unsigned int rds_consumer_idx;
1270         unsigned int sds_consumer_idx;
1271         struct phantom_sds *sds;
1272         unsigned int sds_handle;
1273         unsigned int sds_opcode;
1274
1275         /* Check for TX completions */
1276         cds_consumer_idx = phantom->cds_consumer_idx;
1277         raw_new_cds_consumer_idx = phantom->desc->cmd_cons;
1278         new_cds_consumer_idx = le32_to_cpu ( raw_new_cds_consumer_idx );
1279         while ( cds_consumer_idx != new_cds_consumer_idx ) {
1280                 DBGC2 ( phantom, "Phantom %p CDS %d complete\n",
1281                         phantom, cds_consumer_idx );
1282                 /* Completions may be for commands other than TX, so
1283                  * there may not always be an associated I/O buffer.
1284                  */
1285                 if ( ( iobuf = phantom->cds_iobuf[cds_consumer_idx] ) ) {
1286                         netdev_tx_complete ( netdev, iobuf );
1287                         phantom->cds_iobuf[cds_consumer_idx] = NULL;
1288                 }
1289                 cds_consumer_idx = ( ( cds_consumer_idx + 1 ) % PHN_NUM_CDS );
1290                 phantom->cds_consumer_idx = cds_consumer_idx;
1291         }
1292
1293         /* Check for received packets */
1294         rds_consumer_idx = phantom->rds_consumer_idx;
1295         sds_consumer_idx = phantom->sds_consumer_idx;
1296         while ( 1 ) {
1297                 sds = &phantom->desc->sds[sds_consumer_idx];
1298                 if ( NX_GET ( sds, owner ) == 0 )
1299                         break;
1300
1301                 DBGC2 ( phantom, "Phantom %p SDS %d status:\n",
1302                         phantom, sds_consumer_idx );
1303                 DBGC2_HDA ( phantom, virt_to_bus ( sds ), sds, sizeof (*sds) );
1304
1305                 /* Check received opcode */
1306                 sds_opcode = NX_GET ( sds, opcode );
1307                 if ( ( sds_opcode == UNM_RXPKT_DESC ) ||
1308                      ( sds_opcode == UNM_SYN_OFFLOAD ) ) {
1309
1310                         /* Sanity check: ensure that all of the SDS
1311                          * descriptor has been written.
1312                          */
1313                         if ( NX_GET ( sds, total_length ) == 0 ) {
1314                                 DBGC ( phantom, "Phantom %p SDS %d "
1315                                        "incomplete; deferring\n",
1316                                        phantom, sds_consumer_idx );
1317                                 /* Leave for next poll() */
1318                                 break;
1319                         }
1320
1321                         /* Process received packet */
1322                         sds_handle = NX_GET ( sds, handle );
1323                         iobuf = phantom->rds_iobuf[sds_handle];
1324                         assert ( iobuf != NULL );
1325                         iob_put ( iobuf, NX_GET ( sds, total_length ) );
1326                         iob_pull ( iobuf, NX_GET ( sds, pkt_offset ) );
1327                         DBGC2 ( phantom, "Phantom %p RDS %d complete\n",
1328                                 phantom, sds_handle );
1329                         netdev_rx ( netdev, iobuf );
1330                         phantom->rds_iobuf[sds_handle] = NULL;
1331
1332                         /* Update RDS consumer counter.  This is a
1333                          * lower bound for the number of descriptors
1334                          * that have been read by the hardware, since
1335                          * the hardware must have read at least one
1336                          * descriptor for each completion that we
1337                          * receive.
1338                          */
1339                         rds_consumer_idx =
1340                                 ( ( rds_consumer_idx + 1 ) % PHN_NUM_RDS );
1341                         phantom->rds_consumer_idx = rds_consumer_idx;
1342
1343                 } else {
1344
1345                         DBGC ( phantom, "Phantom %p unexpected SDS opcode "
1346                                "%02x\n", phantom, sds_opcode );
1347                         DBGC_HDA ( phantom, virt_to_bus ( sds ),
1348                                    sds, sizeof ( *sds ) );
1349                 }
1350                         
1351                 /* Clear status descriptor */
1352                 memset ( sds, 0, sizeof ( *sds ) );
1353
1354                 /* Update SDS consumer index */
1355                 sds_consumer_idx = ( ( sds_consumer_idx + 1 ) % PHN_NUM_SDS );
1356                 phantom->sds_consumer_idx = sds_consumer_idx;
1357                 wmb();
1358                 phantom_writel ( phantom, phantom->sds_consumer_idx,
1359                                  phantom->sds_consumer_crb );
1360         }
1361
1362         /* Refill the RX descriptor ring */
1363         phantom_refill_rx_ring ( netdev );
1364
1365         /* Occasionally poll the link state */
1366         if ( phantom->link_poll_timer-- == 0 ) {
1367                 phantom_poll_link_state ( netdev );
1368                 /* Reset the link poll timer */
1369                 phantom->link_poll_timer = PHN_LINK_POLL_FREQUENCY;
1370         }
1371 }
1372
1373 /**
1374  * Enable/disable interrupts
1375  *
1376  * @v netdev    Network device
1377  * @v enable    Interrupts should be enabled
1378  */
1379 static void phantom_irq ( struct net_device *netdev, int enable ) {
1380         struct phantom_nic *phantom = netdev_priv ( netdev );
1381         static const unsigned long sw_int_mask_reg[PHN_MAX_NUM_PORTS] = {
1382                 UNM_NIC_REG_SW_INT_MASK_0,
1383                 UNM_NIC_REG_SW_INT_MASK_1,
1384                 UNM_NIC_REG_SW_INT_MASK_2,
1385                 UNM_NIC_REG_SW_INT_MASK_3
1386         };
1387
1388         phantom_writel ( phantom,
1389                          ( enable ? 1 : 0 ),
1390                          sw_int_mask_reg[phantom->port] );
1391 }
1392
1393 /** Phantom net device operations */
1394 static struct net_device_operations phantom_operations = {
1395         .open           = phantom_open,
1396         .close          = phantom_close,
1397         .transmit       = phantom_transmit,
1398         .poll           = phantom_poll,
1399         .irq            = phantom_irq,
1400 };
1401
1402 /***************************************************************************
1403  *
1404  * CLP settings
1405  *
1406  */
1407
1408 /** Phantom CLP settings tag magic */
1409 #define PHN_CLP_TAG_MAGIC 0xc19c1900UL
1410
1411 /** Phantom CLP settings tag magic mask */
1412 #define PHN_CLP_TAG_MAGIC_MASK 0xffffff00UL
1413
1414 /** Phantom CLP data
1415  *
1416  */
1417 union phantom_clp_data {
1418         /** Data bytes
1419          *
1420          * This field is right-aligned; if only N bytes are present
1421          * then bytes[0]..bytes[7-N] should be zero, and the data
1422          * should be in bytes[7-N+1] to bytes[7];
1423          */
1424         uint8_t bytes[8];
1425         /** Dwords for the CLP interface */
1426         struct {
1427                 /** High dword, in network byte order */
1428                 uint32_t hi;
1429                 /** Low dword, in network byte order */
1430                 uint32_t lo;
1431         } dwords;
1432 };
1433 #define PHN_CLP_BLKSIZE ( sizeof ( union phantom_clp_data ) )
1434
1435 /**
1436  * Wait for Phantom CLP command to complete
1437  *
1438  * @v phantom           Phantom NIC
1439  * @ret rc              Return status code
1440  */
1441 static int phantom_clp_wait ( struct phantom_nic *phantom ) {
1442         unsigned int retries;
1443         uint32_t status;
1444
1445         for ( retries = 0 ; retries < PHN_CLP_CMD_TIMEOUT_MS ; retries++ ) {
1446                 status = phantom_readl ( phantom, UNM_CAM_RAM_CLP_STATUS );
1447                 if ( status & UNM_CAM_RAM_CLP_STATUS_DONE )
1448                         return 0;
1449                 mdelay ( 1 );
1450         }
1451
1452         DBGC ( phantom, "Phantom %p timed out waiting for CLP command\n",
1453                phantom );
1454         return -ETIMEDOUT;
1455 }
1456
1457 /**
1458  * Issue Phantom CLP command
1459  *
1460  * @v phantom           Phantom NIC
1461  * @v port              Virtual port number
1462  * @v opcode            Opcode
1463  * @v data_in           Data in, or NULL
1464  * @v data_out          Data out, or NULL
1465  * @v offset            Offset within data
1466  * @v len               Data buffer length
1467  * @ret len             Total transfer length (for reads), or negative error
1468  */
1469 static int phantom_clp_cmd ( struct phantom_nic *phantom, unsigned int port,
1470                              unsigned int opcode, const void *data_in,
1471                              void *data_out, size_t offset, size_t len ) {
1472         union phantom_clp_data data;
1473         unsigned int index = ( offset / sizeof ( data ) );
1474         unsigned int last = 0;
1475         size_t in_frag_len;
1476         uint8_t *in_frag;
1477         uint32_t command;
1478         uint32_t status;
1479         size_t read_len;
1480         unsigned int error;
1481         size_t out_frag_len;
1482         uint8_t *out_frag;
1483         int rc;
1484
1485         /* Sanity checks */
1486         assert ( ( offset % sizeof ( data ) ) == 0 );
1487         if ( len > 255 ) {
1488                 DBGC ( phantom, "Phantom %p invalid CLP length %zd\n",
1489                        phantom, len );
1490                 return -EINVAL;
1491         }
1492
1493         /* Check that CLP interface is ready */
1494         if ( ( rc = phantom_clp_wait ( phantom ) ) != 0 )
1495                 return rc;
1496
1497         /* Copy data in */
1498         memset ( &data, 0, sizeof ( data ) );
1499         if ( data_in ) {
1500                 assert ( offset < len );
1501                 in_frag_len = ( len - offset );
1502                 if ( in_frag_len > sizeof ( data ) ) {
1503                         in_frag_len = sizeof ( data );
1504                 } else {
1505                         last = 1;
1506                 }
1507                 in_frag = &data.bytes[ sizeof ( data ) - in_frag_len ];
1508                 memcpy ( in_frag, ( data_in + offset ), in_frag_len );
1509                 phantom_writel ( phantom, be32_to_cpu ( data.dwords.lo ),
1510                                  UNM_CAM_RAM_CLP_DATA_LO );
1511                 phantom_writel ( phantom, be32_to_cpu ( data.dwords.hi ),
1512                                  UNM_CAM_RAM_CLP_DATA_HI );
1513         }
1514
1515         /* Issue CLP command */
1516         command = ( ( index << 24 ) | ( ( data_in ? len : 0 ) << 16 ) |
1517                     ( port << 8 ) | ( last << 7 ) | ( opcode << 0 ) );
1518         phantom_writel ( phantom, command, UNM_CAM_RAM_CLP_COMMAND );
1519         mb();
1520         phantom_writel ( phantom, UNM_CAM_RAM_CLP_STATUS_START,
1521                          UNM_CAM_RAM_CLP_STATUS );
1522
1523         /* Wait for command to complete */
1524         if ( ( rc = phantom_clp_wait ( phantom ) ) != 0 )
1525                 return rc;
1526
1527         /* Get command status */
1528         status = phantom_readl ( phantom, UNM_CAM_RAM_CLP_STATUS );
1529         read_len = ( ( status >> 16 ) & 0xff );
1530         error = ( ( status >> 8 ) & 0xff );
1531         if ( error ) {
1532                 DBGC ( phantom, "Phantom %p CLP command error %02x\n",
1533                        phantom, error );
1534                 return -EIO;
1535         }
1536
1537         /* Copy data out */
1538         if ( data_out ) {
1539                 data.dwords.lo = cpu_to_be32 ( phantom_readl ( phantom,
1540                                                   UNM_CAM_RAM_CLP_DATA_LO ) );
1541                 data.dwords.hi = cpu_to_be32 ( phantom_readl ( phantom,
1542                                                   UNM_CAM_RAM_CLP_DATA_HI ) );
1543                 out_frag_len = ( read_len - offset );
1544                 if ( out_frag_len > sizeof ( data ) )
1545                         out_frag_len = sizeof ( data );
1546                 out_frag = &data.bytes[ sizeof ( data ) - out_frag_len ];
1547                 if ( out_frag_len > ( len - offset ) )
1548                         out_frag_len = ( len - offset );
1549                 memcpy ( ( data_out + offset ), out_frag, out_frag_len );
1550         }
1551
1552         return read_len;
1553 }
1554
1555 /**
1556  * Store Phantom CLP setting
1557  *
1558  * @v phantom           Phantom NIC
1559  * @v port              Virtual port number
1560  * @v setting           Setting number
1561  * @v data              Data buffer
1562  * @v len               Length of data buffer
1563  * @ret rc              Return status code
1564  */
1565 static int phantom_clp_store ( struct phantom_nic *phantom, unsigned int port,
1566                                unsigned int setting, const void *data,
1567                                size_t len ) {
1568         unsigned int opcode = setting;
1569         size_t offset;
1570         int rc;
1571
1572         for ( offset = 0 ; offset < len ; offset += PHN_CLP_BLKSIZE ) {
1573                 if ( ( rc = phantom_clp_cmd ( phantom, port, opcode, data,
1574                                               NULL, offset, len ) ) < 0 )
1575                         return rc;
1576         }
1577         return 0;
1578 }
1579
1580 /**
1581  * Fetch Phantom CLP setting
1582  *
1583  * @v phantom           Phantom NIC
1584  * @v port              Virtual port number
1585  * @v setting           Setting number
1586  * @v data              Data buffer
1587  * @v len               Length of data buffer
1588  * @ret len             Length of setting, or negative error
1589  */
1590 static int phantom_clp_fetch ( struct phantom_nic *phantom, unsigned int port,
1591                                unsigned int setting, void *data, size_t len ) {
1592         unsigned int opcode = ( setting + 1 );
1593         size_t offset = 0;
1594         int read_len;
1595
1596         while ( 1 ) {
1597                 read_len = phantom_clp_cmd ( phantom, port, opcode, NULL,
1598                                              data, offset, len );
1599                 if ( read_len < 0 )
1600                         return read_len;
1601                 offset += PHN_CLP_BLKSIZE;
1602                 if ( offset >= ( unsigned ) read_len )
1603                         break;
1604                 if ( offset >= len )
1605                         break;
1606         }
1607         return read_len;
1608 }
1609
1610 /** A Phantom CLP setting */
1611 struct phantom_clp_setting {
1612         /** gPXE setting */
1613         struct setting *setting;
1614         /** Setting number */
1615         unsigned int clp_setting;
1616 };
1617
1618 /** Phantom CLP settings */
1619 static struct phantom_clp_setting clp_settings[] = {
1620         { &mac_setting, 0x01 },
1621 };
1622
1623 /**
1624  * Find Phantom CLP setting
1625  *
1626  * @v setting           gPXE setting
1627  * @v clp_setting       Setting number, or 0 if not found
1628  */
1629 static unsigned int
1630 phantom_clp_setting ( struct phantom_nic *phantom, struct setting *setting ) {
1631         struct phantom_clp_setting *clp_setting;
1632         unsigned int i;
1633
1634         /* Search the list of explicitly-defined settings */
1635         for ( i = 0 ; i < ( sizeof ( clp_settings ) /
1636                             sizeof ( clp_settings[0] ) ) ; i++ ) {
1637                 clp_setting = &clp_settings[i];
1638                 if ( setting_cmp ( setting, clp_setting->setting ) == 0 )
1639                         return clp_setting->clp_setting;
1640         }
1641
1642         /* Allow for use of numbered settings */
1643         if ( ( setting->tag & PHN_CLP_TAG_MAGIC_MASK ) == PHN_CLP_TAG_MAGIC )
1644                 return ( setting->tag & ~PHN_CLP_TAG_MAGIC_MASK );
1645
1646         DBGC2 ( phantom, "Phantom %p has no \"%s\" setting\n",
1647                 phantom, setting->name );
1648
1649         return 0;
1650 }
1651
1652 /**
1653  * Store Phantom CLP setting
1654  *
1655  * @v settings          Settings block
1656  * @v setting           Setting to store
1657  * @v data              Setting data, or NULL to clear setting
1658  * @v len               Length of setting data
1659  * @ret rc              Return status code
1660  */
1661 static int phantom_store_setting ( struct settings *settings,
1662                                    struct setting *setting,
1663                                    const void *data, size_t len ) {
1664         struct phantom_nic *phantom =
1665                 container_of ( settings, struct phantom_nic, settings );
1666         unsigned int clp_setting;
1667         int rc;
1668
1669         /* Find Phantom setting equivalent to gPXE setting */
1670         clp_setting = phantom_clp_setting ( phantom, setting );
1671         if ( ! clp_setting )
1672                 return -ENOTSUP;
1673
1674         /* Store setting */
1675         if ( ( rc = phantom_clp_store ( phantom, phantom->port,
1676                                         clp_setting, data, len ) ) != 0 ) {
1677                 DBGC ( phantom, "Phantom %p could not store setting \"%s\": "
1678                        "%s\n", phantom, setting->name, strerror ( rc ) );
1679                 return rc;
1680         }
1681
1682         return 0;
1683 }
1684
1685 /**
1686  * Fetch Phantom CLP setting
1687  *
1688  * @v settings          Settings block
1689  * @v setting           Setting to fetch
1690  * @v data              Buffer to fill with setting data
1691  * @v len               Length of buffer
1692  * @ret len             Length of setting data, or negative error
1693  */
1694 static int phantom_fetch_setting ( struct settings *settings,
1695                                    struct setting *setting,
1696                                    void *data, size_t len ) {
1697         struct phantom_nic *phantom =
1698                 container_of ( settings, struct phantom_nic, settings );
1699         unsigned int clp_setting;
1700         int read_len;
1701         int rc;
1702
1703         /* Find Phantom setting equivalent to gPXE setting */
1704         clp_setting = phantom_clp_setting ( phantom, setting );
1705         if ( ! clp_setting )
1706                 return -ENOTSUP;
1707
1708         /* Fetch setting */
1709         if ( ( read_len = phantom_clp_fetch ( phantom, phantom->port,
1710                                               clp_setting, data, len ) ) < 0 ){
1711                 rc = read_len;
1712                 DBGC ( phantom, "Phantom %p could not fetch setting \"%s\": "
1713                        "%s\n", phantom, setting->name, strerror ( rc ) );
1714                 return rc;
1715         }
1716
1717         return read_len;
1718 }
1719
1720 /** Phantom CLP settings operations */
1721 static struct settings_operations phantom_settings_operations = {
1722         .store          = phantom_store_setting,
1723         .fetch          = phantom_fetch_setting,
1724 };
1725
1726 /***************************************************************************
1727  *
1728  * Initialisation
1729  *
1730  */
1731
1732 /**
1733  * Map Phantom CRB window
1734  *
1735  * @v phantom           Phantom NIC
1736  * @ret rc              Return status code
1737  */
1738 static int phantom_map_crb ( struct phantom_nic *phantom,
1739                              struct pci_device *pci ) {
1740         unsigned long bar0_start;
1741         unsigned long bar0_size;
1742
1743         bar0_start = pci_bar_start ( pci, PCI_BASE_ADDRESS_0 );
1744         bar0_size = pci_bar_size ( pci, PCI_BASE_ADDRESS_0 );
1745         DBGC ( phantom, "Phantom %p is PCI %02x:%02x.%x with BAR0 at "
1746                "%08lx+%lx\n", phantom, pci->bus, PCI_SLOT ( pci->devfn ),
1747                PCI_FUNC ( pci->devfn ), bar0_start, bar0_size );
1748
1749         if ( ! bar0_start ) {
1750                 DBGC ( phantom, "Phantom %p BAR not assigned; ignoring\n",
1751                        phantom );
1752                 return -EINVAL;
1753         }
1754
1755         switch ( bar0_size ) {
1756         case ( 128 * 1024 * 1024 ) :
1757                 DBGC ( phantom, "Phantom %p has 128MB BAR\n", phantom );
1758                 phantom->crb_access = phantom_crb_access_128m;
1759                 break;
1760         case ( 32 * 1024 * 1024 ) :
1761                 DBGC ( phantom, "Phantom %p has 32MB BAR\n", phantom );
1762                 phantom->crb_access = phantom_crb_access_32m;
1763                 break;
1764         case ( 2 * 1024 * 1024 ) :
1765                 DBGC ( phantom, "Phantom %p has 2MB BAR\n", phantom );
1766                 phantom->crb_access = phantom_crb_access_2m;
1767                 break;
1768         default:
1769                 DBGC ( phantom, "Phantom %p has bad BAR size\n", phantom );
1770                 return -EINVAL;
1771         }
1772
1773         phantom->bar0 = ioremap ( bar0_start, bar0_size );
1774         if ( ! phantom->bar0 ) {
1775                 DBGC ( phantom, "Phantom %p could not map BAR0\n", phantom );
1776                 return -EIO;
1777         }
1778
1779         /* Mark current CRB window as invalid, so that the first
1780          * read/write will set the current window.
1781          */
1782         phantom->crb_window = -1UL;
1783
1784         return 0;
1785 }
1786
1787 /**
1788  * Unhalt all PEGs
1789  *
1790  * @v phantom           Phantom NIC
1791  */
1792 static void phantom_unhalt_pegs ( struct phantom_nic *phantom ) {
1793         uint32_t halt_status;
1794
1795         halt_status = phantom_readl ( phantom, UNM_PEG_0_HALT_STATUS );
1796         phantom_writel ( phantom, halt_status, UNM_PEG_0_HALT_STATUS );
1797         halt_status = phantom_readl ( phantom, UNM_PEG_1_HALT_STATUS );
1798         phantom_writel ( phantom, halt_status, UNM_PEG_1_HALT_STATUS );
1799         halt_status = phantom_readl ( phantom, UNM_PEG_2_HALT_STATUS );
1800         phantom_writel ( phantom, halt_status, UNM_PEG_2_HALT_STATUS );
1801         halt_status = phantom_readl ( phantom, UNM_PEG_3_HALT_STATUS );
1802         phantom_writel ( phantom, halt_status, UNM_PEG_3_HALT_STATUS );
1803         halt_status = phantom_readl ( phantom, UNM_PEG_4_HALT_STATUS );
1804         phantom_writel ( phantom, halt_status, UNM_PEG_4_HALT_STATUS );
1805 }
1806
1807 /**
1808  * Initialise the Phantom command PEG
1809  *
1810  * @v phantom           Phantom NIC
1811  * @ret rc              Return status code
1812  */
1813 static int phantom_init_cmdpeg ( struct phantom_nic *phantom ) {
1814         uint32_t cold_boot;
1815         uint32_t sw_reset;
1816         unsigned int retries;
1817         uint32_t cmdpeg_state;
1818         uint32_t last_cmdpeg_state = 0;
1819
1820         /* Check for a previous initialisation.  This could have
1821          * happened if, for example, the BIOS used the UNDI API to
1822          * drive the NIC prior to a full PXE boot.
1823          */
1824         cmdpeg_state = phantom_readl ( phantom, UNM_NIC_REG_CMDPEG_STATE );
1825         if ( cmdpeg_state == UNM_NIC_REG_CMDPEG_STATE_INITIALIZE_ACK ) {
1826                 DBGC ( phantom, "Phantom %p command PEG already initialized\n",
1827                        phantom );
1828                 /* Unhalt the PEGs.  Previous firmware (e.g. BOFM) may
1829                  * have halted the PEGs to prevent internal bus
1830                  * collisions when the BIOS re-reads the expansion ROM.
1831                  */
1832                 phantom_unhalt_pegs ( phantom );
1833                 return 0;
1834         }
1835
1836         /* If this was a cold boot, check that the hardware came up ok */
1837         cold_boot = phantom_readl ( phantom, UNM_CAM_RAM_COLD_BOOT );
1838         if ( cold_boot == UNM_CAM_RAM_COLD_BOOT_MAGIC ) {
1839                 DBGC ( phantom, "Phantom %p coming up from cold boot\n",
1840                        phantom );
1841                 sw_reset = phantom_readl ( phantom, UNM_ROMUSB_GLB_SW_RESET );
1842                 if ( sw_reset != UNM_ROMUSB_GLB_SW_RESET_MAGIC ) {
1843                         DBGC ( phantom, "Phantom %p reset failed: %08x\n",
1844                                phantom, sw_reset );
1845                         return -EIO;
1846                 }
1847         } else {
1848                 DBGC ( phantom, "Phantom %p coming up from warm boot "
1849                        "(%08x)\n", phantom, cold_boot );
1850         }
1851         /* Clear cold-boot flag */
1852         phantom_writel ( phantom, 0, UNM_CAM_RAM_COLD_BOOT );
1853
1854         /* Set port modes */
1855         phantom_writel ( phantom, UNM_CAM_RAM_PORT_MODE_AUTO_NEG_1G,
1856                          UNM_CAM_RAM_WOL_PORT_MODE );
1857
1858         /* Pass dummy DMA area to card */
1859         phantom_write_hilo ( phantom, 0,
1860                              UNM_NIC_REG_DUMMY_BUF_ADDR_LO,
1861                              UNM_NIC_REG_DUMMY_BUF_ADDR_HI );
1862         phantom_writel ( phantom, UNM_NIC_REG_DUMMY_BUF_INIT,
1863                          UNM_NIC_REG_DUMMY_BUF );
1864
1865         /* Tell the hardware that tuning is complete */
1866         phantom_writel ( phantom, UNM_ROMUSB_GLB_PEGTUNE_DONE_MAGIC,
1867                          UNM_ROMUSB_GLB_PEGTUNE_DONE );
1868
1869         /* Wait for command PEG to finish initialising */
1870         DBGC ( phantom, "Phantom %p initialising command PEG (will take up to "
1871                "%d seconds)...\n", phantom, PHN_CMDPEG_INIT_TIMEOUT_SEC );
1872         for ( retries = 0; retries < PHN_CMDPEG_INIT_TIMEOUT_SEC; retries++ ) {
1873                 cmdpeg_state = phantom_readl ( phantom,
1874                                                UNM_NIC_REG_CMDPEG_STATE );
1875                 if ( cmdpeg_state != last_cmdpeg_state ) {
1876                         DBGC ( phantom, "Phantom %p command PEG state is "
1877                                "%08x after %d seconds...\n",
1878                                phantom, cmdpeg_state, retries );
1879                         last_cmdpeg_state = cmdpeg_state;
1880                 }
1881                 if ( cmdpeg_state == UNM_NIC_REG_CMDPEG_STATE_INITIALIZED ) {
1882                         /* Acknowledge the PEG initialisation */
1883                         phantom_writel ( phantom,
1884                                        UNM_NIC_REG_CMDPEG_STATE_INITIALIZE_ACK,
1885                                        UNM_NIC_REG_CMDPEG_STATE );
1886                         return 0;
1887                 }
1888                 mdelay ( 1000 );
1889         }
1890
1891         DBGC ( phantom, "Phantom %p timed out waiting for command PEG to "
1892                "initialise (status %08x)\n", phantom, cmdpeg_state );
1893         return -ETIMEDOUT;
1894 }
1895
1896 /**
1897  * Read Phantom MAC address
1898  *
1899  * @v phanton_port      Phantom NIC
1900  * @v ll_addr           Buffer to fill with MAC address
1901  */
1902 static void phantom_get_macaddr ( struct phantom_nic *phantom,
1903                                   uint8_t *ll_addr ) {
1904         union {
1905                 uint8_t mac_addr[2][ETH_ALEN];
1906                 uint32_t dwords[3];
1907         } u;
1908         unsigned long offset;
1909         int i;
1910
1911         /* Read the three dwords that include this MAC address and one other */
1912         offset = ( UNM_CAM_RAM_MAC_ADDRS +
1913                    ( 12 * ( phantom->port / 2 ) ) );
1914         for ( i = 0 ; i < 3 ; i++, offset += 4 ) {
1915                 u.dwords[i] = phantom_readl ( phantom, offset );
1916         }
1917
1918         /* Copy out the relevant MAC address */
1919         for ( i = 0 ; i < ETH_ALEN ; i++ ) {
1920                 ll_addr[ ETH_ALEN - i - 1 ] =
1921                         u.mac_addr[ phantom->port & 1 ][i];
1922         }
1923         DBGC ( phantom, "Phantom %p MAC address is %s\n",
1924                phantom, eth_ntoa ( ll_addr ) );
1925 }
1926
1927 /**
1928  * Check Phantom is enabled for boot
1929  *
1930  * @v phanton_port      Phantom NIC
1931  * @ret rc              Return status code
1932  *
1933  * This is something of an ugly hack to accommodate an OEM
1934  * requirement.  The NIC has only one expansion ROM BAR, rather than
1935  * one per port.  To allow individual ports to be selectively
1936  * enabled/disabled for PXE boot (as required), we must therefore
1937  * leave the expansion ROM always enabled, and place the per-port
1938  * enable/disable logic within the gPXE driver.
1939  */
1940 static int phantom_check_boot_enable ( struct phantom_nic *phantom ) {
1941         unsigned long boot_enable;
1942
1943         boot_enable = phantom_readl ( phantom, UNM_CAM_RAM_BOOT_ENABLE );
1944         if ( ! ( boot_enable & ( 1 << phantom->port ) ) ) {
1945                 DBGC ( phantom, "Phantom %p PXE boot is disabled\n",
1946                        phantom );
1947                 return -ENOTSUP;
1948         }
1949
1950         return 0;
1951 }
1952
1953 /**
1954  * Initialise Phantom receive PEG
1955  *
1956  * @v phantom           Phantom NIC
1957  * @ret rc              Return status code
1958  */
1959 static int phantom_init_rcvpeg ( struct phantom_nic *phantom ) {
1960         unsigned int retries;
1961         uint32_t rcvpeg_state;
1962         uint32_t last_rcvpeg_state = 0;
1963
1964         DBGC ( phantom, "Phantom %p initialising receive PEG (will take up to "
1965                "%d seconds)...\n", phantom, PHN_RCVPEG_INIT_TIMEOUT_SEC );
1966         for ( retries = 0; retries < PHN_RCVPEG_INIT_TIMEOUT_SEC; retries++ ) {
1967                 rcvpeg_state = phantom_readl ( phantom,
1968                                                UNM_NIC_REG_RCVPEG_STATE );
1969                 if ( rcvpeg_state != last_rcvpeg_state ) {
1970                         DBGC ( phantom, "Phantom %p receive PEG state is "
1971                                "%08x after %d seconds...\n",
1972                                phantom, rcvpeg_state, retries );
1973                         last_rcvpeg_state = rcvpeg_state;
1974                 }
1975                 if ( rcvpeg_state == UNM_NIC_REG_RCVPEG_STATE_INITIALIZED )
1976                         return 0;
1977                 mdelay ( 1000 );
1978         }
1979
1980         DBGC ( phantom, "Phantom %p timed out waiting for receive PEG to "
1981                "initialise (status %08x)\n", phantom, rcvpeg_state );
1982         return -ETIMEDOUT;
1983 }
1984
1985 /**
1986  * Probe PCI device
1987  *
1988  * @v pci               PCI device
1989  * @v id                PCI ID
1990  * @ret rc              Return status code
1991  */
1992 static int phantom_probe ( struct pci_device *pci,
1993                            const struct pci_device_id *id __unused ) {
1994         struct net_device *netdev;
1995         struct phantom_nic *phantom;
1996         struct settings *parent_settings;
1997         int rc;
1998
1999         /* Allocate Phantom device */
2000         netdev = alloc_etherdev ( sizeof ( *phantom ) );
2001         if ( ! netdev ) {
2002                 rc = -ENOMEM;
2003                 goto err_alloc_etherdev;
2004         }
2005         netdev_init ( netdev, &phantom_operations );
2006         phantom = netdev_priv ( netdev );
2007         pci_set_drvdata ( pci, netdev );
2008         netdev->dev = &pci->dev;
2009         memset ( phantom, 0, sizeof ( *phantom ) );
2010         phantom->port = PCI_FUNC ( pci->devfn );
2011         assert ( phantom->port < PHN_MAX_NUM_PORTS );
2012         settings_init ( &phantom->settings,
2013                         &phantom_settings_operations,
2014                         &netdev->refcnt, "clp", PHN_CLP_TAG_MAGIC );
2015
2016         /* Fix up PCI device */
2017         adjust_pci_device ( pci );
2018
2019         /* Map CRB */
2020         if ( ( rc = phantom_map_crb ( phantom, pci ) ) != 0 )
2021                 goto err_map_crb;
2022
2023         /* BUG5945 - need to hack PCI config space on P3 B1 silicon.
2024          * B2 will have this fixed; remove this hack when B1 is no
2025          * longer in use.
2026          */
2027         if ( PCI_FUNC ( pci->devfn ) == 0 ) {
2028                 unsigned int i;
2029                 for ( i = 0 ; i < 8 ; i++ ) {
2030                         uint32_t temp;
2031                         pci->devfn = PCI_DEVFN ( PCI_SLOT ( pci->devfn ), i );
2032                         pci_read_config_dword ( pci, 0xc8, &temp );
2033                         pci_read_config_dword ( pci, 0xc8, &temp );
2034                         pci_write_config_dword ( pci, 0xc8, 0xf1000 );
2035                 }
2036                 pci->devfn = PCI_DEVFN ( PCI_SLOT ( pci->devfn ), 0 );
2037         }
2038
2039         /* Initialise the command PEG */
2040         if ( ( rc = phantom_init_cmdpeg ( phantom ) ) != 0 )
2041                 goto err_init_cmdpeg;
2042
2043         /* Initialise the receive PEG */
2044         if ( ( rc = phantom_init_rcvpeg ( phantom ) ) != 0 )
2045                 goto err_init_rcvpeg;
2046
2047         /* Read MAC addresses */
2048         phantom_get_macaddr ( phantom, netdev->ll_addr );
2049
2050         /* Skip if boot disabled on NIC */
2051         if ( ( rc = phantom_check_boot_enable ( phantom ) ) != 0 )
2052                 goto err_check_boot_enable;
2053
2054         /* Register network devices */
2055         if ( ( rc = register_netdev ( netdev ) ) != 0 ) {
2056                 DBGC ( phantom, "Phantom %p could not register net device: "
2057                        "%s\n", phantom, strerror ( rc ) );
2058                 goto err_register_netdev;
2059         }
2060
2061         /* Register settings blocks */
2062         parent_settings = netdev_settings ( netdev );
2063         if ( ( rc = register_settings ( &phantom->settings,
2064                                         parent_settings ) ) != 0 ) {
2065                 DBGC ( phantom, "Phantom %p could not register settings: "
2066                        "%s\n", phantom, strerror ( rc ) );
2067                 goto err_register_settings;
2068         }
2069
2070         return 0;
2071
2072         unregister_settings ( &phantom->settings );
2073  err_register_settings:
2074         unregister_netdev ( netdev );
2075  err_register_netdev:
2076  err_check_boot_enable:
2077  err_init_rcvpeg:
2078  err_init_cmdpeg:
2079  err_map_crb:
2080         netdev_nullify ( netdev );
2081         netdev_put ( netdev );
2082  err_alloc_etherdev:
2083         return rc;
2084 }
2085
2086 /**
2087  * Remove PCI device
2088  *
2089  * @v pci               PCI device
2090  */
2091 static void phantom_remove ( struct pci_device *pci ) {
2092         struct net_device *netdev = pci_get_drvdata ( pci );
2093         struct phantom_nic *phantom = netdev_priv ( netdev );
2094
2095         unregister_settings ( &phantom->settings );
2096         unregister_netdev ( netdev );
2097         netdev_nullify ( netdev );
2098         netdev_put ( netdev );
2099 }
2100
2101 /** Phantom PCI IDs */
2102 static struct pci_device_id phantom_nics[] = {
2103         PCI_ROM ( 0x4040, 0x0100, "nx", "NX", 0 ),
2104 };
2105
2106 /** Phantom PCI driver */
2107 struct pci_driver phantom_driver __pci_driver = {
2108         .ids = phantom_nics,
2109         .id_count = ( sizeof ( phantom_nics ) / sizeof ( phantom_nics[0] ) ),
2110         .probe = phantom_probe,
2111         .remove = phantom_remove,
2112 };