source: mainline/uspace/drv/nic/ne2k/ne2k.c@ 83f29e0

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 83f29e0 was 54a1ca7, checked in by Jiri Svoboda <jiri@…>, 11 years ago

Convert NIC drivers away from DDF_DATA_IMPLANT.
  • Property mode set to 100644
File size: 10.7 KB
Line 
1/*
2 * Copyright (c) 2011 Martin Decky
3 * Copyright (c) 2011 Radim Vansa
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/**
31 * @addtogroup drv_ne2k
32 * @brief Novell NE2000 NIC driver
33 * @{
34 */
35/**
36 * @file
37 * @brief Bridge between NICF, DDF and business logic for the NIC
38 */
39
40#include <stdio.h>
41#include <errno.h>
42#include <irc.h>
43#include <stdlib.h>
44#include <str_error.h>
45#include <async.h>
46#include "dp8390.h"
47
48#define NAME "ne2k"
49
50/** Return the ISR from the interrupt call.
51 *
52 * @param[in] call The interrupt call.
53 *
54 */
55#define IRQ_GET_ISR(call) ((int) IPC_GET_ARG2(call))
56
57/** Return the TSR from the interrupt call.
58 *
59 * @param[in] call The interrupt call.
60 *
61 */
62#define IRQ_GET_TSR(call) ((int) IPC_GET_ARG3(call))
63
64#define DRIVER_DATA(dev) ((nic_t *) ddf_dev_data_get(dev))
65#define NE2K(device) ((ne2k_t *) nic_get_specific(DRIVER_DATA(device)))
66
67static irq_pio_range_t ne2k_ranges_prototype[] = {
68 {
69 .base = 0,
70 .size = NE2K_IO_SIZE,
71 }
72};
73
74/** NE2000 kernel interrupt command sequence.
75 *
76 */
77static irq_cmd_t ne2k_cmds_prototype[] = {
78 {
79 /* Read Interrupt Status Register */
80 .cmd = CMD_PIO_READ_8,
81 .addr = NULL,
82 .dstarg = 2
83 },
84 {
85 /* Mask supported interrupt causes */
86 .cmd = CMD_AND,
87 .value = (ISR_PRX | ISR_PTX | ISR_RXE | ISR_TXE | ISR_OVW |
88 ISR_CNT | ISR_RDC),
89 .srcarg = 2,
90 .dstarg = 3,
91 },
92 {
93 /* Predicate for accepting the interrupt */
94 .cmd = CMD_PREDICATE,
95 .value = 4,
96 .srcarg = 3
97 },
98 {
99 /*
100 * Mask future interrupts via
101 * Interrupt Mask Register
102 */
103 .cmd = CMD_PIO_WRITE_8,
104 .addr = NULL,
105 .value = 0
106 },
107 {
108 /* Acknowledge the current interrupt */
109 .cmd = CMD_PIO_WRITE_A_8,
110 .addr = NULL,
111 .srcarg = 3
112 },
113 {
114 /* Read Transmit Status Register */
115 .cmd = CMD_PIO_READ_8,
116 .addr = NULL,
117 .dstarg = 3
118 },
119 {
120 .cmd = CMD_ACCEPT
121 }
122};
123
124static void ne2k_interrupt_handler(ddf_dev_t *dev, ipc_callid_t iid,
125 ipc_call_t *call);
126
127static int ne2k_register_interrupt(nic_t *nic_data)
128{
129 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
130
131 if (ne2k->code.cmdcount == 0) {
132 irq_pio_range_t *ne2k_ranges;
133 irq_cmd_t *ne2k_cmds;
134
135 ne2k_ranges = malloc(sizeof(ne2k_ranges_prototype));
136 if (!ne2k_ranges)
137 return ENOMEM;
138 memcpy(ne2k_ranges, ne2k_ranges_prototype,
139 sizeof(ne2k_ranges_prototype));
140 ne2k_ranges[0].base = (uintptr_t) ne2k->base_port;
141
142 ne2k_cmds = malloc(sizeof(ne2k_cmds_prototype));
143 if (!ne2k_cmds) {
144 free(ne2k_ranges);
145 return ENOMEM;
146 }
147 memcpy(ne2k_cmds, ne2k_cmds_prototype,
148 sizeof(ne2k_cmds_prototype));
149 ne2k_cmds[0].addr = ne2k->base_port + DP_ISR;
150 ne2k_cmds[3].addr = ne2k->base_port + DP_IMR;
151 ne2k_cmds[4].addr = ne2k_cmds[0].addr;
152 ne2k_cmds[5].addr = ne2k->base_port + DP_TSR;
153
154 ne2k->code.rangecount = sizeof(ne2k_ranges_prototype) /
155 sizeof(irq_pio_range_t);
156 ne2k->code.ranges = ne2k_ranges;
157
158 ne2k->code.cmdcount = sizeof(ne2k_cmds_prototype) /
159 sizeof(irq_cmd_t);
160 ne2k->code.cmds = ne2k_cmds;
161 }
162
163 int rc = register_interrupt_handler(nic_get_ddf_dev(nic_data),
164 ne2k->irq, ne2k_interrupt_handler, &ne2k->code);
165 return rc;
166}
167
168static ddf_dev_ops_t ne2k_dev_ops;
169
170static void ne2k_dev_cleanup(ddf_dev_t *dev)
171{
172 if (ddf_dev_data_get(dev) != NULL) {
173 ne2k_t *ne2k = NE2K(dev);
174 if (ne2k) {
175 free(ne2k->code.ranges);
176 free(ne2k->code.cmds);
177 }
178 nic_unbind_and_destroy(dev);
179 }
180}
181
182static int ne2k_dev_init(nic_t *nic_data)
183{
184 /* Get HW resources */
185 hw_res_list_parsed_t hw_res_parsed;
186 hw_res_list_parsed_init(&hw_res_parsed);
187
188 int rc = nic_get_resources(nic_data, &hw_res_parsed);
189
190 if (rc != EOK)
191 goto failed;
192
193 if (hw_res_parsed.irqs.count == 0) {
194 rc = EINVAL;
195 goto failed;
196 }
197
198 if (hw_res_parsed.io_ranges.count == 0) {
199 rc = EINVAL;
200 goto failed;
201 }
202
203 if (hw_res_parsed.io_ranges.ranges[0].size < NE2K_IO_SIZE) {
204 rc = EINVAL;
205 goto failed;
206 }
207
208 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
209 ne2k->irq = hw_res_parsed.irqs.irqs[0];
210
211 addr_range_t regs = hw_res_parsed.io_ranges.ranges[0];
212 ne2k->base_port = RNGABSPTR(regs);
213
214 hw_res_list_parsed_clean(&hw_res_parsed);
215
216 /* Enable programmed I/O */
217 if (pio_enable_range(&regs, &ne2k->port) != EOK)
218 return EADDRNOTAVAIL;
219
220 ne2k->data_port = ne2k->port + NE2K_DATA;
221 ne2k->receive_configuration = RCR_AB | RCR_AM;
222 ne2k->probed = false;
223 ne2k->up = false;
224
225 /* Find out whether the device is present. */
226 if (ne2k_probe(ne2k) != EOK)
227 return ENOENT;
228
229 ne2k->probed = true;
230
231 rc = ne2k_register_interrupt(nic_data);
232 if (rc != EOK)
233 return EINVAL;
234
235 return EOK;
236
237failed:
238 hw_res_list_parsed_clean(&hw_res_parsed);
239 return rc;
240}
241
242void ne2k_interrupt_handler(ddf_dev_t *dev, ipc_callid_t iid, ipc_call_t *call)
243{
244 nic_t *nic_data = DRIVER_DATA(dev);
245 ne2k_interrupt(nic_data, IRQ_GET_ISR(*call), IRQ_GET_TSR(*call));
246
247 async_answer_0(iid, EOK);
248}
249
250static int ne2k_on_activating(nic_t *nic_data)
251{
252 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
253
254 if (!ne2k->up) {
255 int rc = ne2k_up(ne2k);
256 if (rc != EOK)
257 return rc;
258
259 rc = irc_enable_interrupt(ne2k->irq);
260 if (rc != EOK) {
261 ne2k_down(ne2k);
262 return rc;
263 }
264 }
265 return EOK;
266}
267
268static int ne2k_on_stopping(nic_t *nic_data)
269{
270 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
271
272 (void) irc_disable_interrupt(ne2k->irq);
273 ne2k->receive_configuration = RCR_AB | RCR_AM;
274 ne2k_down(ne2k);
275 return EOK;
276}
277
278static int ne2k_set_address(ddf_fun_t *fun, const nic_address_t *address)
279{
280 nic_t *nic_data = DRIVER_DATA(ddf_fun_get_dev(fun));
281 int rc = nic_report_address(nic_data, address);
282 if (rc != EOK) {
283 return EINVAL;
284 }
285 /* Note: some frame with previous physical address may slip to NIL here
286 * (for a moment the filtering is not exact), but ethernet should be OK with
287 * that. Some frames may also be lost, but this is not a problem.
288 */
289 ne2k_set_physical_address((ne2k_t *) nic_get_specific(nic_data), address);
290 return EOK;
291}
292
293static int ne2k_on_unicast_mode_change(nic_t *nic_data,
294 nic_unicast_mode_t new_mode,
295 const nic_address_t *address_list, size_t address_count)
296{
297 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
298 switch (new_mode) {
299 case NIC_UNICAST_BLOCKED:
300 ne2k_set_promisc_phys(ne2k, false);
301 nic_report_hw_filtering(nic_data, 0, -1, -1);
302 return EOK;
303 case NIC_UNICAST_DEFAULT:
304 ne2k_set_promisc_phys(ne2k, false);
305 nic_report_hw_filtering(nic_data, 1, -1, -1);
306 return EOK;
307 case NIC_UNICAST_LIST:
308 ne2k_set_promisc_phys(ne2k, true);
309 nic_report_hw_filtering(nic_data, 0, -1, -1);
310 return EOK;
311 case NIC_UNICAST_PROMISC:
312 ne2k_set_promisc_phys(ne2k, true);
313 nic_report_hw_filtering(nic_data, 1, -1, -1);
314 return EOK;
315 default:
316 return ENOTSUP;
317 }
318}
319
320static int ne2k_on_multicast_mode_change(nic_t *nic_data,
321 nic_multicast_mode_t new_mode,
322 const nic_address_t *address_list, size_t address_count)
323{
324 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
325 switch (new_mode) {
326 case NIC_MULTICAST_BLOCKED:
327 ne2k_set_accept_mcast(ne2k, false);
328 nic_report_hw_filtering(nic_data, -1, 1, -1);
329 return EOK;
330 case NIC_MULTICAST_LIST:
331 ne2k_set_accept_mcast(ne2k, true);
332 ne2k_set_mcast_hash(ne2k,
333 nic_mcast_hash(address_list, address_count));
334 nic_report_hw_filtering(nic_data, -1, 0, -1);
335 return EOK;
336 case NIC_MULTICAST_PROMISC:
337 ne2k_set_accept_mcast(ne2k, true);
338 ne2k_set_mcast_hash(ne2k, 0xFFFFFFFFFFFFFFFFllu);
339 nic_report_hw_filtering(nic_data, -1, 1, -1);
340 return EOK;
341 default:
342 return ENOTSUP;
343 }
344}
345
346static int ne2k_on_broadcast_mode_change(nic_t *nic_data,
347 nic_broadcast_mode_t new_mode)
348{
349 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
350 switch (new_mode) {
351 case NIC_BROADCAST_BLOCKED:
352 ne2k_set_accept_bcast(ne2k, false);
353 return EOK;
354 case NIC_BROADCAST_ACCEPTED:
355 ne2k_set_accept_bcast(ne2k, true);
356 return EOK;
357 default:
358 return ENOTSUP;
359 }
360}
361
362static int ne2k_dev_add(ddf_dev_t *dev)
363{
364 ddf_fun_t *fun;
365
366 /* Allocate driver data for the device. */
367 nic_t *nic_data = nic_create_and_bind(dev);
368 if (nic_data == NULL)
369 return ENOMEM;
370
371 nic_set_send_frame_handler(nic_data, ne2k_send);
372 nic_set_state_change_handlers(nic_data,
373 ne2k_on_activating, NULL, ne2k_on_stopping);
374 nic_set_filtering_change_handlers(nic_data,
375 ne2k_on_unicast_mode_change, ne2k_on_multicast_mode_change,
376 ne2k_on_broadcast_mode_change, NULL, NULL);
377
378 ne2k_t *ne2k = malloc(sizeof(ne2k_t));
379 if (NULL != ne2k) {
380 memset(ne2k, 0, sizeof(ne2k_t));
381 nic_set_specific(nic_data, ne2k);
382 } else {
383 nic_unbind_and_destroy(dev);
384 return ENOMEM;
385 }
386
387 int rc = ne2k_dev_init(nic_data);
388 if (rc != EOK) {
389 ne2k_dev_cleanup(dev);
390 return rc;
391 }
392
393 rc = nic_report_address(nic_data, &ne2k->mac);
394 if (rc != EOK) {
395 ne2k_dev_cleanup(dev);
396 return rc;
397 }
398
399 fun = ddf_fun_create(nic_get_ddf_dev(nic_data), fun_exposed, "port0");
400 if (fun == NULL) {
401 ne2k_dev_cleanup(dev);
402 return ENOMEM;
403 }
404
405 nic_set_ddf_fun(nic_data, fun);
406 ddf_fun_set_ops(fun, &ne2k_dev_ops);
407
408 rc = ddf_fun_bind(fun);
409 if (rc != EOK) {
410 ddf_fun_destroy(fun);
411 ne2k_dev_cleanup(dev);
412 return rc;
413 }
414
415 rc = ddf_fun_add_to_category(fun, DEVICE_CATEGORY_NIC);
416 if (rc != EOK) {
417 ddf_fun_unbind(fun);
418 ddf_fun_destroy(fun);
419 return rc;
420 }
421
422 return EOK;
423}
424
425static nic_iface_t ne2k_nic_iface = {
426 .set_address = ne2k_set_address
427};
428
429static driver_ops_t ne2k_driver_ops = {
430 .dev_add = ne2k_dev_add
431};
432
433static driver_t ne2k_driver = {
434 .name = NAME,
435 .driver_ops = &ne2k_driver_ops
436};
437
438int main(int argc, char *argv[])
439{
440 printf("%s: HelenOS NE 2000 network adapter driver\n", NAME);
441
442 nic_driver_init(NAME);
443 nic_driver_implement(&ne2k_driver_ops, &ne2k_dev_ops, &ne2k_nic_iface);
444
445 return ddf_driver_main(&ne2k_driver);
446}
447
448/** @}
449 */
Note: See TracBrowser for help on using the repository browser.