1 /*
2  * Copyright (C) 2017 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 #include <stdint.h>
27 #include <string.h>
28 #include <strings.h>
29 #include <unistd.h>
30 #include <errno.h>
31 #include <byteswap.h>
32 #include <ipxe/netdevice.h>
33 #include <ipxe/ethernet.h>
34 #include <ipxe/if_ether.h>
35 #include <ipxe/iobuf.h>
36 #include <ipxe/malloc.h>
37 #include <ipxe/umalloc.h>
38 #include <ipxe/pci.h>
39 #include "exanic.h"
40 
41 /** @file
42  *
43  * Exablaze ExaNIC driver
44  *
45  */
46 
47 /* Disambiguate the various error causes */
48 #define EIO_ABORTED __einfo_error ( EINFO_EIO_ABORTED )
49 #define EINFO_EIO_ABORTED \
50 	__einfo_uniqify ( EINFO_EIO, 0x01, "Frame aborted" )
51 #define EIO_CORRUPT __einfo_error ( EINFO_EIO_CORRUPT )
52 #define EINFO_EIO_CORRUPT \
53 	__einfo_uniqify ( EINFO_EIO, 0x02, "CRC incorrect" )
54 #define EIO_HWOVFL __einfo_error ( EINFO_EIO_HWOVFL )
55 #define EINFO_EIO_HWOVFL \
56 	__einfo_uniqify ( EINFO_EIO, 0x03, "Hardware overflow" )
57 #define EIO_STATUS( status ) \
58 	EUNIQ ( EINFO_EIO, ( (status) & EXANIC_STATUS_ERROR_MASK ), \
59 		EIO_ABORTED, EIO_CORRUPT, EIO_HWOVFL )
60 
61 /**
62  * Write DMA base address register
63  *
64  * @v addr		DMA base address
65  * @v reg		Register
66  */
exanic_write_base(physaddr_t addr,void * reg)67 static void exanic_write_base ( physaddr_t addr, void *reg ) {
68 	uint32_t lo;
69 	uint32_t hi;
70 
71 	/* Write high and low registers, setting flags as appropriate */
72 	lo = addr;
73 	if ( sizeof ( physaddr_t ) > sizeof ( uint32_t ) ) {
74 		/* 64-bit build; may be a 32-bit or 64-bit address */
75 		hi = ( ( ( uint64_t ) addr ) >> 32 );
76 		if ( ! hi )
77 			lo |= EXANIC_DMA_32_BIT;
78 	} else {
79 		/* 32-bit build; always a 32-bit address */
80 		hi = 0;
81 		lo |= EXANIC_DMA_32_BIT;
82 	}
83 	writel ( hi, ( reg + 0 ) );
84 	writel ( lo, ( reg + 4 ) );
85 }
86 
87 /**
88  * Clear DMA base address register
89  *
90  * @v reg		Register
91  */
exanic_clear_base(void * reg)92 static inline void exanic_clear_base ( void *reg ) {
93 
94 	/* Clear both high and low registers */
95 	writel ( 0, ( reg + 0 ) );
96 	writel ( 0, ( reg + 4 ) );
97 }
98 
99 /******************************************************************************
100  *
101  * Device reset
102  *
103  ******************************************************************************
104  */
105 
106 /**
107  * Reset hardware
108  *
109  * @v exanic		ExaNIC device
110  */
exanic_reset(struct exanic * exanic)111 static void exanic_reset ( struct exanic *exanic ) {
112 	void *port_regs;
113 	unsigned int i;
114 
115 	/* Disable all possible ports */
116 	for ( i = 0 ; i < EXANIC_MAX_PORTS ; i++ ) {
117 		port_regs = ( exanic->regs + EXANIC_PORT_REGS ( i ) );
118 		writel ( 0, ( port_regs + EXANIC_PORT_ENABLE ) );
119 		writel ( 0, ( port_regs + EXANIC_PORT_IRQ ) );
120 		exanic_clear_base ( port_regs + EXANIC_PORT_RX_BASE );
121 	}
122 
123 	/* Disable transmit feedback */
124 	exanic_clear_base ( exanic->regs + EXANIC_TXF_BASE );
125 }
126 
127 /******************************************************************************
128  *
129  * MAC address
130  *
131  ******************************************************************************
132  */
133 
134 /**
135  * Read I2C line status
136  *
137  * @v basher		Bit-bashing interface
138  * @v bit_id		Bit number
139  * @ret zero		Input is a logic 0
140  * @ret non-zero	Input is a logic 1
141  */
exanic_i2c_read_bit(struct bit_basher * basher,unsigned int bit_id)142 static int exanic_i2c_read_bit ( struct bit_basher *basher,
143 				 unsigned int bit_id ) {
144 	struct exanic *exanic =
145 		container_of ( basher, struct exanic, basher.basher );
146 	unsigned int shift;
147 	uint32_t i2c;
148 
149 	/* Identify bit */
150 	assert ( bit_id == I2C_BIT_SDA );
151 	shift = exanic->i2cfg.getsda;
152 
153 	/* Read I2C register */
154 	DBG_DISABLE ( DBGLVL_IO );
155 	i2c = readl ( exanic->regs + EXANIC_I2C );
156 	DBG_ENABLE ( DBGLVL_IO );
157 	return ( ( i2c >> shift ) & 1 );
158 }
159 
160 /**
161  * Write I2C line status
162  *
163  * @v basher		Bit-bashing interface
164  * @v bit_id		Bit number
165  * @v data		Value to write
166  */
exanic_i2c_write_bit(struct bit_basher * basher,unsigned int bit_id,unsigned long data)167 static void exanic_i2c_write_bit ( struct bit_basher *basher,
168 				   unsigned int bit_id, unsigned long data ) {
169 	struct exanic *exanic =
170 		container_of ( basher, struct exanic, basher.basher );
171 	unsigned int shift;
172 	uint32_t mask;
173 	uint32_t i2c;
174 
175 	/* Identify shift */
176 	assert ( ( bit_id == I2C_BIT_SCL ) || ( bit_id == I2C_BIT_SDA ) );
177 	shift = ( ( bit_id == I2C_BIT_SCL ) ?
178 		  exanic->i2cfg.setscl : exanic->i2cfg.setsda );
179 	mask = ( 1UL << shift );
180 
181 	/* Modify I2C register */
182 	DBG_DISABLE ( DBGLVL_IO );
183 	i2c = readl ( exanic->regs + EXANIC_I2C );
184 	i2c &= ~mask;
185 	if ( ! data )
186 		i2c |= mask;
187 	writel ( i2c, ( exanic->regs + EXANIC_I2C ) );
188 	DBG_ENABLE ( DBGLVL_IO );
189 }
190 
191 /** I2C bit-bashing interface operations */
192 static struct bit_basher_operations exanic_i2c_basher_ops = {
193 	.read = exanic_i2c_read_bit,
194 	.write = exanic_i2c_write_bit,
195 };
196 
197 /** Possible I2C bus configurations */
198 static struct exanic_i2c_config exanic_i2cfgs[] = {
199 	/* X2/X10 */
200 	{ .setscl = 7, .setsda = 4, .getsda = 12 },
201 	/* X4 */
202 	{ .setscl = 7, .setsda = 5, .getsda = 13 },
203 };
204 
205 /**
206  * Initialise EEPROM
207  *
208  * @v exanic		ExaNIC device
209  * @v i2cfg		I2C bus configuration
210  * @ret rc		Return status code
211  */
exanic_try_init_eeprom(struct exanic * exanic,struct exanic_i2c_config * i2cfg)212 static int exanic_try_init_eeprom ( struct exanic *exanic,
213 				    struct exanic_i2c_config *i2cfg ) {
214 	int rc;
215 
216 	/* Configure I2C bus */
217 	memcpy ( &exanic->i2cfg, i2cfg, sizeof ( exanic->i2cfg ) );
218 
219 	/* Initialise I2C bus */
220 	if ( ( rc = init_i2c_bit_basher ( &exanic->basher,
221 					  &exanic_i2c_basher_ops ) ) != 0 ) {
222 		DBGC2 ( exanic, "EXANIC %p found no I2C bus via %d/%d/%d\n",
223 			exanic, exanic->i2cfg.setscl,
224 			exanic->i2cfg.setsda, exanic->i2cfg.getsda );
225 		return rc;
226 	}
227 
228 	/* Check for EEPROM presence */
229 	init_i2c_eeprom ( &exanic->eeprom, EXANIC_EEPROM_ADDRESS );
230 	if ( ( rc = i2c_check_presence ( &exanic->basher.i2c,
231 					 &exanic->eeprom ) ) != 0 ) {
232 		DBGC2 ( exanic, "EXANIC %p found no EEPROM via %d/%d/%d\n",
233 			exanic, exanic->i2cfg.setscl,
234 			exanic->i2cfg.setsda, exanic->i2cfg.getsda );
235 		return rc;
236 	}
237 
238 	DBGC ( exanic, "EXANIC %p found EEPROM via %d/%d/%d\n",
239 	       exanic, exanic->i2cfg.setscl,
240 	       exanic->i2cfg.setsda, exanic->i2cfg.getsda );
241 	return 0;
242 }
243 
244 /**
245  * Initialise EEPROM
246  *
247  * @v exanic		ExaNIC device
248  * @ret rc		Return status code
249  */
exanic_init_eeprom(struct exanic * exanic)250 static int exanic_init_eeprom ( struct exanic *exanic ) {
251 	struct exanic_i2c_config *i2cfg;
252 	unsigned int i;
253 	int rc;
254 
255 	/* Try all possible bus configurations */
256 	for ( i = 0 ; i < ( sizeof ( exanic_i2cfgs ) /
257 			    sizeof ( exanic_i2cfgs[0] ) ) ; i++ ) {
258 		i2cfg = &exanic_i2cfgs[i];
259 		if ( ( rc = exanic_try_init_eeprom ( exanic, i2cfg ) ) == 0 )
260 			return 0;
261 	}
262 
263 	DBGC ( exanic, "EXANIC %p found no EEPROM\n", exanic );
264 	return -ENODEV;
265 }
266 
267 /**
268  * Fetch base MAC address
269  *
270  * @v exanic		ExaNIC device
271  * @ret rc		Return status code
272  */
exanic_fetch_mac(struct exanic * exanic)273 static int exanic_fetch_mac ( struct exanic *exanic ) {
274 	struct i2c_interface *i2c = &exanic->basher.i2c;
275 	int rc;
276 
277 	/* Initialise EEPROM */
278 	if ( ( rc = exanic_init_eeprom ( exanic ) ) != 0 )
279 		return rc;
280 
281 	/* Fetch base MAC address */
282 	if ( ( rc = i2c->read ( i2c, &exanic->eeprom, 0, exanic->mac,
283 				sizeof ( exanic->mac ) ) ) != 0 ) {
284 		DBGC ( exanic, "EXANIC %p could not read MAC address: %s\n",
285 		       exanic, strerror ( rc ) );
286 		return rc;
287 	}
288 
289 	return 0;
290 }
291 
292 /******************************************************************************
293  *
294  * Link state
295  *
296  ******************************************************************************
297  */
298 
299 /**
300  * Check link state
301  *
302  * @v netdev		Network device
303  */
exanic_check_link(struct net_device * netdev)304 static void exanic_check_link ( struct net_device *netdev ) {
305 	struct exanic_port *port = netdev->priv;
306 	uint32_t status;
307 	uint32_t speed;
308 
309 	/* Report port status changes */
310 	status = readl ( port->regs + EXANIC_PORT_STATUS );
311 	speed = readl ( port->regs + EXANIC_PORT_SPEED );
312 	if ( status != port->status ) {
313 		DBGC ( port, "EXANIC %s port status %#08x speed %dMbps\n",
314 		       netdev->name, status, speed );
315 		if ( status & EXANIC_PORT_STATUS_LINK ) {
316 			netdev_link_up ( netdev );
317 		} else {
318 			netdev_link_down ( netdev );
319 		}
320 		port->status = status;
321 	}
322 }
323 
324 /**
325  * Check link state periodically
326  *
327  * @v retry		Link state check timer
328  * @v over		Failure indicator
329  */
exanic_expired(struct retry_timer * timer,int over __unused)330 static void exanic_expired ( struct retry_timer *timer, int over __unused ) {
331 	struct exanic_port *port =
332 		container_of ( timer, struct exanic_port, timer );
333 	struct net_device *netdev = port->netdev;
334 	static const uint32_t speeds[] = {
335 		100, 1000, 10000, 40000, 100000,
336 	};
337 	unsigned int index;
338 
339 	/* Restart timer */
340 	start_timer_fixed ( timer, EXANIC_LINK_INTERVAL );
341 
342 	/* Check link state */
343 	exanic_check_link ( netdev );
344 
345 	/* Do nothing further if link is already up */
346 	if ( netdev_link_ok ( netdev ) )
347 		return;
348 
349 	/* Do nothing further unless we have a valid list of supported speeds */
350 	if ( ! port->speeds )
351 		return;
352 
353 	/* Autonegotiation is not supported; try manually selecting
354 	 * the next supported link speed.
355 	 */
356 	do {
357 		if ( ! port->speed )
358 			port->speed = ( 8 * sizeof ( port->speeds ) );
359 		port->speed--;
360 	} while ( ! ( ( 1UL << port->speed ) & port->speeds ) );
361 	index = ( port->speed - ( ffs ( EXANIC_CAPS_SPEED_MASK ) - 1 ) );
362 	assert ( index < ( sizeof ( speeds ) / sizeof ( speeds[0] ) ) );
363 
364 	/* Attempt the selected speed */
365 	DBGC ( netdev, "EXANIC %s attempting %dMbps\n",
366 	       netdev->name, speeds[index] );
367 	writel ( speeds[index], ( port->regs + EXANIC_PORT_SPEED ) );
368 }
369 
370 /******************************************************************************
371  *
372  * Network device interface
373  *
374  ******************************************************************************
375  */
376 
377 /**
378  * Open network device
379  *
380  * @v netdev		Network device
381  * @ret rc		Return status code
382  */
exanic_open(struct net_device * netdev)383 static int exanic_open ( struct net_device *netdev ) {
384 	struct exanic_port *port = netdev->priv;
385 	struct exanic_tx_chunk *tx;
386 	unsigned int i;
387 
388 	/* Reset transmit region contents */
389 	for ( i = 0 ; i < port->tx_count ; i++ ) {
390 		tx = ( port->tx + ( i * sizeof ( *tx ) ) );
391 		writew ( port->txf_slot, &tx->desc.txf_slot );
392 		writeb ( EXANIC_TYPE_RAW, &tx->desc.type );
393 		writeb ( 0, &tx->desc.flags );
394 		writew ( 0, &tx->pad );
395 	}
396 
397 	/* Reset receive region contents */
398 	memset_user ( port->rx, 0, 0xff, EXANIC_RX_LEN );
399 
400 	/* Reset transmit feedback region */
401 	*(port->txf) = 0;
402 
403 	/* Reset counters */
404 	port->tx_prod = 0;
405 	port->tx_cons = 0;
406 	port->rx_cons = 0;
407 
408 	/* Map receive region */
409 	exanic_write_base ( phys_to_bus ( user_to_phys ( port->rx, 0 ) ),
410 			    ( port->regs + EXANIC_PORT_RX_BASE ) );
411 
412 	/* Enable promiscuous mode */
413 	writel ( EXANIC_PORT_FLAGS_PROMISC,
414 		 ( port->regs + EXANIC_PORT_FLAGS ) );
415 
416 	/* Reset to default speed and clear cached status */
417 	writel ( port->default_speed, ( port->regs + EXANIC_PORT_SPEED ) );
418 	port->speed = 0;
419 	port->status = 0;
420 
421 	/* Enable port */
422 	wmb();
423 	writel ( EXANIC_PORT_ENABLE_ENABLED,
424 		 ( port->regs + EXANIC_PORT_ENABLE ) );
425 
426 	/* Start link state timer */
427 	start_timer_fixed ( &port->timer, EXANIC_LINK_INTERVAL );
428 
429 	return 0;
430 }
431 
432 /**
433  * Close network device
434  *
435  * @v netdev		Network device
436  */
exanic_close(struct net_device * netdev)437 static void exanic_close ( struct net_device *netdev ) {
438 	struct exanic_port *port = netdev->priv;
439 
440 	/* Stop link state timer */
441 	stop_timer ( &port->timer );
442 
443 	/* Disable port */
444 	writel ( 0, ( port->regs + EXANIC_PORT_ENABLE ) );
445 	wmb();
446 
447 	/* Clear receive region */
448 	exanic_clear_base ( port->regs + EXANIC_PORT_RX_BASE );
449 
450 	/* Discard any in-progress receive */
451 	if ( port->rx_iobuf ) {
452 		netdev_rx_err ( netdev, port->rx_iobuf, -ECANCELED );
453 		port->rx_iobuf = NULL;
454 	}
455 }
456 
457 /**
458  * Transmit packet
459  *
460  * @v netdev		Network device
461  * @v iobuf		I/O buffer
462  * @ret rc		Return status code
463  */
exanic_transmit(struct net_device * netdev,struct io_buffer * iobuf)464 static int exanic_transmit ( struct net_device *netdev,
465 			     struct io_buffer *iobuf ) {
466 	struct exanic_port *port = netdev->priv;
467 	struct exanic_tx_chunk *tx;
468 	unsigned int tx_fill;
469 	unsigned int tx_index;
470 	size_t offset;
471 	size_t len;
472 	uint8_t *src;
473 	uint8_t *dst;
474 
475 	/* Sanity check */
476 	len = iob_len ( iobuf );
477 	if ( len > sizeof ( tx->data ) ) {
478 		DBGC ( port, "EXANIC %s transmit too large\n", netdev->name );
479 		return -ENOTSUP;
480 	}
481 
482 	/* Get next transmit descriptor */
483 	tx_fill = ( port->tx_prod - port->tx_cons );
484 	if ( tx_fill >= port->tx_count ) {
485 		DBGC ( port, "EXANIC %s out of transmit descriptors\n",
486 		       netdev->name );
487 		return -ENOBUFS;
488 	}
489 	tx_index = ( port->tx_prod & ( port->tx_count - 1 ) );
490 	offset = ( tx_index * sizeof ( *tx ) );
491 	tx = ( port->tx + offset );
492 	DBGC2 ( port, "EXANIC %s TX %04x at [%05zx,%05zx)\n",
493 		netdev->name, port->tx_prod, ( port->tx_offset + offset ),
494 		( port->tx_offset + offset +
495 		  offsetof ( typeof ( *tx ), data ) + len ) );
496 	port->tx_prod++;
497 
498 	/* Populate transmit descriptor */
499 	writew ( port->tx_prod, &tx->desc.txf_id );
500 	writew ( ( sizeof ( tx->pad ) + len ), &tx->desc.len );
501 
502 	/* Copy data to transmit region.  There is no DMA on the
503 	 * transmit data path.
504 	 */
505 	src = iobuf->data;
506 	dst = tx->data;
507 	while ( len-- )
508 		writeb ( *(src++), dst++ );
509 
510 	/* Send transmit command */
511 	wmb();
512 	writel ( ( port->tx_offset + offset ),
513 		 ( port->regs + EXANIC_PORT_TX_COMMAND ) );
514 
515 	return 0;
516 }
517 
518 /**
519  * Poll for completed packets
520  *
521  * @v netdev		Network device
522  */
exanic_poll_tx(struct net_device * netdev)523 static void exanic_poll_tx ( struct net_device *netdev ) {
524 	struct exanic_port *port = netdev->priv;
525 
526 	/* Report any completed packets */
527 	while ( port->tx_cons != *(port->txf) ) {
528 		DBGC2 ( port, "EXANIC %s TX %04x complete\n",
529 			netdev->name, port->tx_cons );
530 		netdev_tx_complete_next ( netdev );
531 		port->tx_cons++;
532 	}
533 }
534 
535 /**
536  * Poll for received packets
537  *
538  * @v netdev		Network device
539  */
exanic_poll_rx(struct net_device * netdev)540 static void exanic_poll_rx ( struct net_device *netdev ) {
541 	struct exanic_port *port = netdev->priv;
542 	struct exanic_rx_chunk *rx;
543 	struct exanic_rx_descriptor desc;
544 	uint8_t current;
545 	uint8_t previous;
546 	size_t offset;
547 	size_t len;
548 
549 	for ( ; ; port->rx_cons++ ) {
550 
551 		/* Fetch descriptor */
552 		offset = ( ( port->rx_cons * sizeof ( *rx ) ) % EXANIC_RX_LEN );
553 		copy_from_user ( &desc, port->rx,
554 				 ( offset + offsetof ( typeof ( *rx ), desc ) ),
555 				 sizeof ( desc ) );
556 
557 		/* Calculate generation */
558 		current = ( port->rx_cons / ( EXANIC_RX_LEN / sizeof ( *rx ) ));
559 		previous = ( current - 1 );
560 
561 		/* Do nothing if no chunk is ready */
562 		if ( desc.generation == previous )
563 			break;
564 
565 		/* Allocate I/O buffer if needed */
566 		if ( ! port->rx_iobuf ) {
567 			port->rx_iobuf = alloc_iob ( EXANIC_MAX_RX_LEN );
568 			if ( ! port->rx_iobuf ) {
569 				/* Wait for next poll */
570 				break;
571 			}
572 			port->rx_rc = 0;
573 		}
574 
575 		/* Calculate chunk length */
576 		len = ( desc.len ? desc.len : sizeof ( rx->data ) );
577 
578 		/* Append data to I/O buffer */
579 		if ( len <= iob_tailroom ( port->rx_iobuf ) ) {
580 			copy_from_user ( iob_put ( port->rx_iobuf, len ),
581 					 port->rx,
582 					 ( offset + offsetof ( typeof ( *rx ),
583 							       data ) ), len );
584 		} else {
585 			DBGC ( port, "EXANIC %s RX too large\n",
586 			       netdev->name );
587 			port->rx_rc = -ERANGE;
588 		}
589 
590 		/* Check for overrun */
591 		rmb();
592 		copy_from_user ( &desc.generation, port->rx,
593 				 ( offset + offsetof ( typeof ( *rx ),
594 						       desc.generation ) ),
595 				 sizeof ( desc.generation ) );
596 		if ( desc.generation != current ) {
597 			DBGC ( port, "EXANIC %s RX overrun\n", netdev->name );
598 			port->rx_rc = -ENOBUFS;
599 			continue;
600 		}
601 
602 		/* Wait for end of packet */
603 		if ( ! desc.len )
604 			continue;
605 
606 		/* Check for receive errors */
607 		if ( desc.status & EXANIC_STATUS_ERROR_MASK ) {
608 			port->rx_rc = -EIO_STATUS ( desc.status );
609 			DBGC ( port, "EXANIC %s RX %04x error: %s\n",
610 			       netdev->name, port->rx_cons,
611 			       strerror ( port->rx_rc ) );
612 		} else {
613 			DBGC2 ( port, "EXANIC %s RX %04x\n",
614 				netdev->name, port->rx_cons );
615 		}
616 
617 		/* Hand off to network stack */
618 		if ( port->rx_rc ) {
619 			netdev_rx_err ( netdev, port->rx_iobuf, port->rx_rc );
620 		} else {
621 			iob_unput ( port->rx_iobuf, 4 /* strip CRC */ );
622 			netdev_rx ( netdev, port->rx_iobuf );
623 		}
624 		port->rx_iobuf = NULL;
625 	}
626 }
627 
628 /**
629  * Poll for completed and received packets
630  *
631  * @v netdev		Network device
632  */
exanic_poll(struct net_device * netdev)633 static void exanic_poll ( struct net_device *netdev ) {
634 
635 	/* Poll for completed packets */
636 	exanic_poll_tx ( netdev );
637 
638 	/* Poll for received packets */
639 	exanic_poll_rx ( netdev );
640 }
641 
642 /** ExaNIC network device operations */
643 static struct net_device_operations exanic_operations = {
644 	.open		= exanic_open,
645 	.close		= exanic_close,
646 	.transmit	= exanic_transmit,
647 	.poll		= exanic_poll,
648 };
649 
650 /******************************************************************************
651  *
652  * PCI interface
653  *
654  ******************************************************************************
655  */
656 
657 /**
658  * Probe port
659  *
660  * @v exanic		ExaNIC device
661  * @v dev		Parent device
662  * @v index		Port number
663  * @ret rc		Return status code
664  */
exanic_probe_port(struct exanic * exanic,struct device * dev,unsigned int index)665 static int exanic_probe_port ( struct exanic *exanic, struct device *dev,
666 			       unsigned int index ) {
667 	struct net_device *netdev;
668 	struct exanic_port *port;
669 	void *port_regs;
670 	uint32_t status;
671 	size_t tx_len;
672 	int rc;
673 
674 	/* Do nothing if port is not physically present */
675 	port_regs = ( exanic->regs + EXANIC_PORT_REGS ( index ) );
676 	status = readl ( port_regs + EXANIC_PORT_STATUS );
677 	tx_len = readl ( port_regs + EXANIC_PORT_TX_LEN );
678 	if ( ( status & EXANIC_PORT_STATUS_ABSENT ) || ( tx_len == 0 ) ) {
679 		rc = 0;
680 		goto absent;
681 	}
682 
683 	/* Allocate network device */
684 	netdev = alloc_etherdev ( sizeof ( *port ) );
685 	if ( ! netdev ) {
686 		rc = -ENOMEM;
687 		goto err_alloc_netdev;
688 	}
689 	netdev_init ( netdev, &exanic_operations );
690 	netdev->dev = dev;
691 	port = netdev->priv;
692 	memset ( port, 0, sizeof ( *port ) );
693 	exanic->port[index] = port;
694 	port->netdev = netdev;
695 	port->regs = port_regs;
696 	timer_init ( &port->timer, exanic_expired, &netdev->refcnt );
697 
698 	/* Identify transmit region */
699 	port->tx_offset = readl ( port->regs + EXANIC_PORT_TX_OFFSET );
700 	if ( tx_len > EXANIC_MAX_TX_LEN )
701 		tx_len = EXANIC_MAX_TX_LEN;
702 	assert ( ! ( tx_len & ( tx_len - 1 ) ) );
703 	port->tx = ( exanic->tx + port->tx_offset );
704 	port->tx_count = ( tx_len / sizeof ( struct exanic_tx_chunk ) );
705 
706 	/* Identify transmit feedback region */
707 	port->txf_slot = EXANIC_TXF_SLOT ( index );
708 	port->txf = ( exanic->txf +
709 		      ( port->txf_slot * sizeof ( *(port->txf) ) ) );
710 
711 	/* Allocate receive region (via umalloc()) */
712 	port->rx = umalloc ( EXANIC_RX_LEN );
713 	if ( ! port->rx ) {
714 		rc = -ENOMEM;
715 		goto err_alloc_rx;
716 	}
717 
718 	/* Set MAC address */
719 	memcpy ( netdev->hw_addr, exanic->mac, ETH_ALEN );
720 	netdev->hw_addr[ ETH_ALEN - 1 ] += index;
721 
722 	/* Record default link speed and supported speeds */
723 	port->default_speed = readl ( port->regs + EXANIC_PORT_SPEED );
724 	port->speeds = ( exanic->caps & EXANIC_CAPS_SPEED_MASK );
725 
726 	/* Register network device */
727 	if ( ( rc = register_netdev ( netdev ) ) != 0 )
728 		goto err_register_netdev;
729 	DBGC ( port, "EXANIC %s port %d TX [%#05zx,%#05zx) TXF %#02x RX "
730 	       "[%#lx,%#lx)\n", netdev->name, index, port->tx_offset,
731 	       ( port->tx_offset + tx_len ), port->txf_slot,
732 	       user_to_phys ( port->rx, 0 ),
733 	       user_to_phys ( port->rx, EXANIC_RX_LEN ) );
734 
735 	/* Set initial link state */
736 	exanic_check_link ( netdev );
737 
738 	return 0;
739 
740 	unregister_netdev ( netdev );
741  err_register_netdev:
742 	ufree ( port->rx );
743  err_alloc_rx:
744 	netdev_nullify ( netdev );
745 	netdev_put ( netdev );
746  err_alloc_netdev:
747  absent:
748 	return rc;
749 }
750 
751 /**
752  * Probe port
753  *
754  * @v exanic		ExaNIC device
755  * @v index		Port number
756  */
exanic_remove_port(struct exanic * exanic,unsigned int index)757 static void exanic_remove_port ( struct exanic *exanic, unsigned int index ) {
758 	struct exanic_port *port;
759 
760 	/* Do nothing if port is not physically present */
761 	port = exanic->port[index];
762 	if ( ! port )
763 		return;
764 
765 	/* Unregister network device */
766 	unregister_netdev ( port->netdev );
767 
768 	/* Free receive region */
769 	ufree ( port->rx );
770 
771 	/* Free network device */
772 	netdev_nullify ( port->netdev );
773 	netdev_put ( port->netdev );
774 }
775 
776 /**
777  * Probe PCI device
778  *
779  * @v pci		PCI device
780  * @ret rc		Return status code
781  */
exanic_probe(struct pci_device * pci)782 static int exanic_probe ( struct pci_device *pci ) {
783 	struct exanic *exanic;
784 	unsigned long regs_bar_start;
785 	unsigned long tx_bar_start;
786 	size_t tx_bar_len;
787 	int i;
788 	int rc;
789 
790 	/* Allocate and initialise structure */
791 	exanic = zalloc ( sizeof ( *exanic ) );
792 	if ( ! exanic ) {
793 		rc = -ENOMEM;
794 		goto err_alloc;
795 	}
796 	pci_set_drvdata ( pci, exanic );
797 
798 	/* Fix up PCI device */
799 	adjust_pci_device ( pci );
800 
801 	/* Map registers */
802 	regs_bar_start = pci_bar_start ( pci, EXANIC_REGS_BAR );
803 	exanic->regs = ioremap ( regs_bar_start, EXANIC_REGS_LEN );
804 	if ( ! exanic->regs ) {
805 		rc = -ENODEV;
806 		goto err_ioremap_regs;
807 	}
808 
809 	/* Reset device */
810 	exanic_reset ( exanic );
811 
812 	/* Read capabilities */
813 	exanic->caps = readl ( exanic->regs + EXANIC_CAPS );
814 
815 	/* Power up PHYs */
816 	writel ( EXANIC_POWER_ON, ( exanic->regs + EXANIC_POWER ) );
817 
818 	/* Fetch base MAC address */
819 	if ( ( rc = exanic_fetch_mac ( exanic ) ) != 0 )
820 		goto err_fetch_mac;
821 	DBGC ( exanic, "EXANIC %p capabilities %#08x base MAC %s\n",
822 	       exanic, exanic->caps, eth_ntoa ( exanic->mac ) );
823 
824 	/* Map transmit region */
825 	tx_bar_start = pci_bar_start ( pci, EXANIC_TX_BAR );
826 	tx_bar_len = pci_bar_size ( pci, EXANIC_TX_BAR );
827 	exanic->tx = ioremap ( tx_bar_start, tx_bar_len );
828 	if ( ! exanic->tx ) {
829 		rc = -ENODEV;
830 		goto err_ioremap_tx;
831 	}
832 
833 	/* Allocate transmit feedback region (shared between all ports) */
834 	exanic->txf = malloc_dma ( EXANIC_TXF_LEN, EXANIC_ALIGN );
835 	if ( ! exanic->txf ) {
836 		rc = -ENOMEM;
837 		goto err_alloc_txf;
838 	}
839 	memset ( exanic->txf, 0, EXANIC_TXF_LEN );
840 	exanic_write_base ( virt_to_bus ( exanic->txf ),
841 			    ( exanic->regs + EXANIC_TXF_BASE ) );
842 
843 	/* Allocate and initialise per-port network devices */
844 	for ( i = 0 ; i < EXANIC_MAX_PORTS ; i++ ) {
845 		if ( ( rc = exanic_probe_port ( exanic, &pci->dev, i ) ) != 0 )
846 			goto err_probe_port;
847 	}
848 
849 	return 0;
850 
851 	i = EXANIC_MAX_PORTS;
852  err_probe_port:
853 	for ( i-- ; i >= 0 ; i-- )
854 		exanic_remove_port ( exanic, i );
855 	exanic_reset ( exanic );
856 	free_dma ( exanic->txf, EXANIC_TXF_LEN );
857  err_alloc_txf:
858 	iounmap ( exanic->tx );
859  err_ioremap_tx:
860 	iounmap ( exanic->regs );
861  err_fetch_mac:
862  err_ioremap_regs:
863 	free ( exanic );
864  err_alloc:
865 	return rc;
866 }
867 
868 /**
869  * Remove PCI device
870  *
871  * @v pci		PCI device
872  */
exanic_remove(struct pci_device * pci)873 static void exanic_remove ( struct pci_device *pci ) {
874 	struct exanic *exanic = pci_get_drvdata ( pci );
875 	unsigned int i;
876 
877 	/* Remove all ports */
878 	for ( i = 0 ; i < EXANIC_MAX_PORTS ; i++ )
879 		exanic_remove_port ( exanic, i );
880 
881 	/* Reset device */
882 	exanic_reset ( exanic );
883 
884 	/* Free transmit feedback region */
885 	free_dma ( exanic->txf, EXANIC_TXF_LEN );
886 
887 	/* Unmap transmit region */
888 	iounmap ( exanic->tx );
889 
890 	/* Unmap registers */
891 	iounmap ( exanic->regs );
892 
893 	/* Free device */
894 	free ( exanic );
895 }
896 
897 /** ExaNIC PCI device IDs */
898 static struct pci_device_id exanic_ids[] = {
899 	PCI_ROM ( 0x10ee, 0x2b00, "exanic-old", "ExaNIC (old)", 0 ),
900 	PCI_ROM ( 0x1ce4, 0x0001, "exanic-x4", "ExaNIC X4", 0 ),
901 	PCI_ROM ( 0x1ce4, 0x0002, "exanic-x2", "ExaNIC X2", 0 ),
902 	PCI_ROM ( 0x1ce4, 0x0003, "exanic-x10", "ExaNIC X10", 0 ),
903 	PCI_ROM ( 0x1ce4, 0x0004, "exanic-x10gm", "ExaNIC X10 GM", 0 ),
904 	PCI_ROM ( 0x1ce4, 0x0005, "exanic-x40", "ExaNIC X40", 0 ),
905 	PCI_ROM ( 0x1ce4, 0x0006, "exanic-x10hpt", "ExaNIC X10 HPT", 0 ),
906 	PCI_ROM ( 0x1ce4, 0x0007, "exanic-x40g", "ExaNIC X40", 0 ),
907 };
908 
909 /** ExaNIC PCI driver */
910 struct pci_driver exanic_driver __pci_driver = {
911 	.ids = exanic_ids,
912 	.id_count = ( sizeof ( exanic_ids ) / sizeof ( exanic_ids[0] ) ),
913 	.probe = exanic_probe,
914 	.remove = exanic_remove,
915 };
916