efb3c6f4ca7cf902f6d6d8b343a95ff9401fb02c
[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 <io.h>
17 #include <vsprintf.h>
18 #include <errno.h>
19 #include <gpxe/pci.h>
20 #include <gpxe/if_ether.h>
21 #include <gpxe/ethernet.h>
22 #include <gpxe/pkbuff.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                                      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                                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 ) {
116         struct pnic *pnic = netdev->priv;
117         struct pk_buff *pkb;
118         uint16_t length;
119         uint16_t qlen;
120
121         /* Fetch all available packets */
122         while ( 1 ) {
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                 pkb = alloc_pkb ( ETH_FRAME_LEN );
130                 if ( ! pkb ) {
131                         printf ( "could not allocate buffer\n" );
132                         break;
133                 }
134                 if ( pnic_command ( pnic, PNIC_CMD_RECV, NULL, 0,
135                                     pkb->data, ETH_FRAME_LEN, &length )
136                      != PNIC_STATUS_OK ) {
137                         free_pkb ( pkb );
138                         break;
139                 }
140                 pkb_put ( pkb, length );
141                 netdev_rx ( netdev, pkb );
142         }
143 }
144
145 /**************************************************************************
146 TRANSMIT - Transmit a frame
147 ***************************************************************************/
148 static int pnic_transmit ( struct net_device *netdev, struct pk_buff *pkb ) {
149         struct pnic *pnic = netdev->priv;
150
151         pnic_command ( pnic, PNIC_CMD_XMIT, pkb->data, pkb_len ( pkb ),
152                        NULL, 0, NULL );
153         free_pkb ( pkb );
154         return 0;
155 }
156
157 /**************************************************************************
158 IRQ - Handle card interrupt status
159 ***************************************************************************/
160 #if 0
161 static void pnic_irq ( struct net_device *netdev, irq_action_t action ) {
162         struct pnic *pnic = netdev->priv;
163         uint8_t enabled;
164
165         switch ( action ) {
166         case DISABLE :
167         case ENABLE :
168                 enabled = ( action == ENABLE ? 1 : 0 );
169                 pnic_command ( pnic, PNIC_CMD_MASK_IRQ,
170                                &enabled, sizeof ( enabled ), NULL, 0, NULL );
171                 break;
172         case FORCE :
173                 pnic_command ( pnic, PNIC_CMD_FORCE_IRQ,
174                                NULL, 0, NULL, 0, NULL );
175                 break;
176         }
177 }
178 #endif
179
180 /**************************************************************************
181 DISABLE - Turn off ethernet interface
182 ***************************************************************************/
183 static void pnic_remove ( struct pci_device *pci ) {
184         struct net_device *netdev = pci_get_drvdata ( pci );
185         struct pnic *pnic = netdev->priv;
186
187         unregister_netdev ( netdev );
188         pnic_command ( pnic, PNIC_CMD_RESET, NULL, 0, NULL, 0, NULL );
189         free_netdev ( netdev );
190 }
191
192 /**************************************************************************
193 PROBE - Look for an adapter, this routine's visible to the outside
194 ***************************************************************************/
195 static int pnic_probe ( struct pci_device *pci,
196                         const struct pci_device_id *id __unused ) {
197         struct net_device *netdev;
198         struct pnic *pnic;
199         uint16_t api_version;
200         uint16_t status;
201         int rc;
202
203         /* Fix up PCI device */
204         adjust_pci_device ( pci );
205         
206         /* Allocate net device */
207         netdev = alloc_etherdev ( sizeof ( *pnic ) );
208         if ( ! netdev ) {
209                 rc = -ENOMEM;
210                 goto err;
211         }
212         pnic = netdev->priv;
213         pci_set_drvdata ( pci, netdev );
214         pnic->ioaddr = pci->ioaddr;
215
216         /* API version check */
217         status = pnic_command_quiet ( pnic, PNIC_CMD_API_VER, NULL, 0,
218                                       &api_version,
219                                       sizeof ( api_version ), NULL );
220         if ( status != PNIC_STATUS_OK ) {
221                 printf ( "PNIC failed installation check, code %#hx\n",
222                          status );
223                 rc = -EIO;
224                 goto err;
225         }
226         pnic_api_check ( api_version );
227
228         /* Get MAC address */
229         status = pnic_command ( pnic, PNIC_CMD_READ_MAC, NULL, 0,
230                                 netdev->ll_addr, ETH_ALEN, NULL );
231
232         /* Point to NIC specific routines */
233         netdev->poll     = pnic_poll;
234         netdev->transmit = pnic_transmit;
235
236         /* Register network device */
237         if ( ( rc = register_netdev ( netdev ) ) != 0 )
238                 goto err;
239
240         return 0;
241
242  err:
243         /* Free net device */
244         free_netdev ( netdev );
245         return rc;
246 }
247
248 static struct pci_device_id pnic_nics[] = {
249 /* genrules.pl doesn't let us use macros for PCI IDs...*/
250 PCI_ROM ( 0xfefe, 0xefef, "pnic", "Bochs Pseudo NIC Adaptor" ),
251 };
252
253 struct pci_driver pnic_driver __pci_driver = {
254         .ids = pnic_nics,
255         .id_count = ( sizeof ( pnic_nics ) / sizeof ( pnic_nics[0] ) ),
256         .probe = pnic_probe,
257         .remove = pnic_remove,
258 };