Use netdev_rx_err() to report receive errors.
[people/sha0/gpxe.git] / src / drivers / net / pnic.c
1 /**************************************************************************
2 Etherboot -  BOOTP/TFTP Bootstrap Program
3 Bochs Pseudo NIC driver for Etherboot
4 ***************************************************************************/
5
6 /*
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License as
9  * published by the Free Software Foundation; either version 2, or (at
10  * your option) any later version.
11  *
12  * See pnic_api.h for an explanation of the Bochs Pseudo NIC.
13  */
14
15 #include <stdint.h>
16 #include <stdio.h>
17 #include <io.h>
18 #include <errno.h>
19 #include <gpxe/pci.h>
20 #include <gpxe/if_ether.h>
21 #include <gpxe/ethernet.h>
22 #include <gpxe/iobuf.h>
23 #include <gpxe/netdevice.h>
24
25 #include "pnic_api.h"
26
27 struct pnic {
28         unsigned short ioaddr;
29 };
30
31 /* 
32  * Utility functions: issue a PNIC command, retrieve result.  Use
33  * pnic_command_quiet if you don't want failure codes to be
34  * automatically printed.  Returns the PNIC status code.
35  * 
36  * Set output_length to NULL only if you expect to receive exactly
37  * output_max_length bytes, otherwise it'll complain that you didn't
38  * get enough data (on the assumption that if you not interested in
39  * discovering the output length then you're expecting a fixed amount
40  * of data).
41  */
42
43 static uint16_t pnic_command_quiet ( struct pnic *pnic, uint16_t command,
44                                      const void *input, uint16_t input_length,
45                                      void *output, uint16_t output_max_length,
46                                      uint16_t *output_length ) {
47         uint16_t status;
48         uint16_t _output_length;
49
50         if ( input != NULL ) {
51                 /* Write input length */
52                 outw ( input_length, pnic->ioaddr + PNIC_REG_LEN );
53                 /* Write input data */
54                 outsb ( pnic->ioaddr + PNIC_REG_DATA, input, input_length );
55         }
56         /* Write command */
57         outw ( command, pnic->ioaddr + PNIC_REG_CMD );
58         /* Retrieve status */
59         status = inw ( pnic->ioaddr + PNIC_REG_STAT );
60         /* Retrieve output length */
61         _output_length = inw ( pnic->ioaddr + PNIC_REG_LEN );
62         if ( output_length == NULL ) {
63                 if ( _output_length != output_max_length ) {
64                         printf ( "pnic_command %#hx: wrong data length "
65                                  "returned (expected %d, got %d)\n", command,
66                                  output_max_length, _output_length );
67                 }
68         } else {
69                 *output_length = _output_length;
70         }
71         if ( output != NULL ) {
72                 if ( _output_length > output_max_length ) {
73                         printf ( "pnic_command %#hx: output buffer too small "
74                                  "(have %d, need %d)\n", command,
75                                  output_max_length, _output_length );
76                         _output_length = output_max_length;
77                 }
78                 /* Retrieve output data */
79                 insb ( pnic->ioaddr + PNIC_REG_DATA, output, _output_length );
80         }
81         return status;
82 }
83
84 static uint16_t pnic_command ( struct pnic *pnic, uint16_t command,
85                                const void *input, uint16_t input_length,
86                                void *output, uint16_t output_max_length,
87                                uint16_t *output_length ) {
88         uint16_t status = pnic_command_quiet ( pnic, command,
89                                                input, input_length,
90                                                output, output_max_length,
91                                                output_length );
92         if ( status == PNIC_STATUS_OK ) return status;
93         printf ( "PNIC command %#hx (len %#hx) failed with status %#hx\n",
94                  command, input_length, status );
95         return status;
96 }
97
98 /* Check API version matches that of NIC */
99 static int pnic_api_check ( uint16_t api_version ) {
100         if ( api_version != PNIC_API_VERSION ) {
101                 printf ( "Warning: API version mismatch! "
102                          "(NIC's is %d.%d, ours is %d.%d)\n",
103                          api_version >> 8, api_version & 0xff,
104                          PNIC_API_VERSION >> 8, PNIC_API_VERSION & 0xff );
105         }
106         if ( api_version < PNIC_API_VERSION ) {
107                 printf ( "** You may need to update your copy of Bochs **\n" );
108         }
109         return ( api_version == PNIC_API_VERSION );
110 }
111
112 /**************************************************************************
113 POLL - Wait for a frame
114 ***************************************************************************/
115 static void pnic_poll ( struct net_device *netdev, unsigned int rx_quota ) {
116         struct pnic *pnic = netdev->priv;
117         struct io_buffer *iobuf;
118         uint16_t length;
119         uint16_t qlen;
120
121         /* Fetch all available packets */
122         while ( rx_quota ) {
123                 if ( pnic_command ( pnic, PNIC_CMD_RECV_QLEN, NULL, 0,
124                                     &qlen, sizeof ( qlen ), NULL )
125                      != PNIC_STATUS_OK )
126                         break;
127                 if ( qlen == 0 )
128                         break;
129                 iobuf = alloc_iob ( ETH_FRAME_LEN );
130                 if ( ! iobuf ) {
131                         DBG ( "could not allocate buffer\n" );
132                         netdev_rx_err ( netdev, NULL, -ENOMEM );
133                         break;
134                 }
135                 if ( pnic_command ( pnic, PNIC_CMD_RECV, NULL, 0,
136                                     iobuf->data, ETH_FRAME_LEN, &length )
137                      != PNIC_STATUS_OK ) {
138                         netdev_rx_err ( netdev, iobuf, -EIO );
139                         break;
140                 }
141                 iob_put ( iobuf, length );
142                 netdev_rx ( netdev, iobuf );
143                 --rx_quota;
144         }
145 }
146
147 /**************************************************************************
148 TRANSMIT - Transmit a frame
149 ***************************************************************************/
150 static int pnic_transmit ( struct net_device *netdev, struct io_buffer *iobuf ) {
151         struct pnic *pnic = netdev->priv;
152
153         /* Pad the packet */
154         iob_pad ( iobuf, ETH_ZLEN );
155
156         /* Send packet */
157         pnic_command ( pnic, PNIC_CMD_XMIT, iobuf->data, iob_len ( iobuf ),
158                        NULL, 0, NULL );
159
160         netdev_tx_complete ( netdev, iobuf );
161         return 0;
162 }
163
164 /**************************************************************************
165 OPEN - Open network device
166 ***************************************************************************/
167 static int pnic_open ( struct net_device *netdev ) {
168         struct pnic *pnic = netdev->priv;
169         static const uint8_t enable = 1;
170
171         /* Enable interrupts */
172         pnic_command ( pnic, PNIC_CMD_MASK_IRQ, &enable,
173                        sizeof ( enable ), NULL, 0, NULL );
174         
175         return 0;
176 }
177
178 /**************************************************************************
179 CLOSE - Close network device
180 ***************************************************************************/
181 static void pnic_close ( struct net_device *netdev ) {
182         struct pnic *pnic = netdev->priv;
183         static const uint8_t disable = 0;
184
185         /* Disable interrupts */
186         pnic_command ( pnic, PNIC_CMD_MASK_IRQ, &disable,
187                        sizeof ( disable ), NULL, 0, NULL );
188 }
189
190 /**************************************************************************
191 DISABLE - Turn off ethernet interface
192 ***************************************************************************/
193 static void pnic_remove ( struct pci_device *pci ) {
194         struct net_device *netdev = pci_get_drvdata ( pci );
195         struct pnic *pnic = netdev->priv;
196
197         unregister_netdev ( netdev );
198         pnic_command ( pnic, PNIC_CMD_RESET, NULL, 0, NULL, 0, NULL );
199         netdev_put ( netdev );
200 }
201
202 /**************************************************************************
203 PROBE - Look for an adapter, this routine's visible to the outside
204 ***************************************************************************/
205 static int pnic_probe ( struct pci_device *pci,
206                         const struct pci_device_id *id __unused ) {
207         struct net_device *netdev;
208         struct pnic *pnic;
209         uint16_t api_version;
210         uint16_t status;
211         int rc;
212
213         /* Allocate net device */
214         netdev = alloc_etherdev ( sizeof ( *pnic ) );
215         if ( ! netdev )
216                 return -ENOMEM;
217         pnic = netdev->priv;
218         pci_set_drvdata ( pci, netdev );
219         netdev->dev = &pci->dev;
220         pnic->ioaddr = pci->ioaddr;
221
222         /* Fix up PCI device */
223         adjust_pci_device ( pci );
224         
225         /* API version check */
226         status = pnic_command_quiet ( pnic, PNIC_CMD_API_VER, NULL, 0,
227                                       &api_version,
228                                       sizeof ( api_version ), NULL );
229         if ( status != PNIC_STATUS_OK ) {
230                 printf ( "PNIC failed installation check, code %#hx\n",
231                          status );
232                 rc = -EIO;
233                 goto err;
234         }
235         pnic_api_check ( api_version );
236
237         /* Get MAC address */
238         status = pnic_command ( pnic, PNIC_CMD_READ_MAC, NULL, 0,
239                                 netdev->ll_addr, ETH_ALEN, NULL );
240
241         /* Point to NIC specific routines */
242         netdev->open     = pnic_open;
243         netdev->close    = pnic_close;
244         netdev->poll     = pnic_poll;
245         netdev->transmit = pnic_transmit;
246
247         /* Register network device */
248         if ( ( rc = register_netdev ( netdev ) ) != 0 )
249                 goto err;
250
251         return 0;
252
253  err:
254         /* Free net device */
255         netdev_put ( netdev );
256         return rc;
257 }
258
259 static struct pci_device_id pnic_nics[] = {
260 /* genrules.pl doesn't let us use macros for PCI IDs...*/
261 PCI_ROM ( 0xfefe, 0xefef, "pnic", "Bochs Pseudo NIC Adaptor" ),
262 };
263
264 struct pci_driver pnic_driver __pci_driver = {
265         .ids = pnic_nics,
266         .id_count = ( sizeof ( pnic_nics ) / sizeof ( pnic_nics[0] ) ),
267         .probe = pnic_probe,
268         .remove = pnic_remove,
269 };