source: mainline/uspace/drv/nic/ne2k/ne2k.c@ 69927fa

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 69927fa was 7c3fb9b, checked in by Jiri Svoboda <jiri@…>, 8 years ago

Fix block comment formatting (ccheck).
  • Property mode set to 100644
File size: 11.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 <device/hw_res.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(ipc_call_t *, ddf_dev_t *);
125
126static errno_t ne2k_register_interrupt(nic_t *nic_data,
127 cap_irq_handle_t *handle)
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 return register_interrupt_handler(nic_get_ddf_dev(nic_data),
164 ne2k->irq, ne2k_interrupt_handler, &ne2k->code, handle);
165}
166
167static ddf_dev_ops_t ne2k_dev_ops;
168
169static void ne2k_dev_cleanup(ddf_dev_t *dev)
170{
171 if (ddf_dev_data_get(dev) != NULL) {
172 ne2k_t *ne2k = NE2K(dev);
173 if (ne2k) {
174 free(ne2k->code.ranges);
175 free(ne2k->code.cmds);
176 }
177 nic_unbind_and_destroy(dev);
178 }
179}
180
181static errno_t ne2k_dev_init(nic_t *nic_data)
182{
183 /* Get HW resources */
184 hw_res_list_parsed_t hw_res_parsed;
185 hw_res_list_parsed_init(&hw_res_parsed);
186
187 errno_t rc = nic_get_resources(nic_data, &hw_res_parsed);
188
189 if (rc != EOK)
190 goto failed;
191
192 if (hw_res_parsed.irqs.count == 0) {
193 rc = EINVAL;
194 goto failed;
195 }
196
197 if (hw_res_parsed.io_ranges.count == 0) {
198 rc = EINVAL;
199 goto failed;
200 }
201
202 if (hw_res_parsed.io_ranges.ranges[0].size < NE2K_IO_SIZE) {
203 rc = EINVAL;
204 goto failed;
205 }
206
207 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
208 ne2k->irq = hw_res_parsed.irqs.irqs[0];
209
210 addr_range_t regs = hw_res_parsed.io_ranges.ranges[0];
211 ne2k->base_port = RNGABSPTR(regs);
212
213 hw_res_list_parsed_clean(&hw_res_parsed);
214
215 /* Enable programmed I/O */
216 if (pio_enable_range(&regs, &ne2k->port) != EOK)
217 return EADDRNOTAVAIL;
218
219 ne2k->data_port = ne2k->port + NE2K_DATA;
220 ne2k->receive_configuration = RCR_AB | RCR_AM;
221 ne2k->probed = false;
222 ne2k->up = false;
223
224 /* Find out whether the device is present. */
225 if (ne2k_probe(ne2k) != EOK)
226 return ENOENT;
227
228 ne2k->probed = true;
229
230 if (ne2k_register_interrupt(nic_data, NULL) != EOK)
231 return EINVAL;
232
233 return EOK;
234
235failed:
236 hw_res_list_parsed_clean(&hw_res_parsed);
237 return rc;
238}
239
240void ne2k_interrupt_handler(ipc_call_t *call, ddf_dev_t *dev)
241{
242 nic_t *nic_data = DRIVER_DATA(dev);
243 ne2k_interrupt(nic_data, IRQ_GET_ISR(*call), IRQ_GET_TSR(*call));
244}
245
246static errno_t ne2k_on_activating(nic_t *nic_data)
247{
248 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
249
250 if (!ne2k->up) {
251 errno_t rc = ne2k_up(ne2k);
252 if (rc != EOK)
253 return rc;
254
255 rc = hw_res_enable_interrupt(ne2k->parent_sess, ne2k->irq);
256 if (rc != EOK) {
257 ne2k_down(ne2k);
258 return rc;
259 }
260 }
261 return EOK;
262}
263
264static errno_t ne2k_on_stopping(nic_t *nic_data)
265{
266 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
267
268 (void) hw_res_disable_interrupt(ne2k->parent_sess, ne2k->irq);
269 ne2k->receive_configuration = RCR_AB | RCR_AM;
270 ne2k_down(ne2k);
271 return EOK;
272}
273
274static errno_t ne2k_set_address(ddf_fun_t *fun, const nic_address_t *address)
275{
276 nic_t *nic_data = DRIVER_DATA(ddf_fun_get_dev(fun));
277 errno_t rc = nic_report_address(nic_data, address);
278 if (rc != EOK) {
279 return EINVAL;
280 }
281 /*
282 * Note: some frame with previous physical address may slip to NIL here
283 * (for a moment the filtering is not exact), but ethernet should be OK with
284 * that. Some frames may also be lost, but this is not a problem.
285 */
286 ne2k_set_physical_address((ne2k_t *) nic_get_specific(nic_data), address);
287 return EOK;
288}
289
290static errno_t ne2k_get_device_info(ddf_fun_t *fun, nic_device_info_t *info)
291{
292 nic_t *nic_data = nic_get_from_ddf_fun(fun);
293 if (!nic_data)
294 return ENOENT;
295
296 str_cpy(info->vendor_name, sizeof(info->vendor_name), "Novell");
297 str_cpy(info->model_name, sizeof(info->model_name), "NE2000");
298
299 return EOK;
300}
301
302static errno_t ne2k_get_cable_state(ddf_fun_t *fun, nic_cable_state_t *state)
303{
304 *state = NIC_CS_PLUGGED;
305 return EOK;
306}
307
308static errno_t ne2k_get_operation_mode(ddf_fun_t *fun, int *speed,
309 nic_channel_mode_t *duplex, nic_role_t *role)
310{
311 *speed = 10;
312 *duplex = NIC_CM_HALF_DUPLEX; // XXX
313 *role = NIC_ROLE_UNKNOWN;
314 return EOK;
315}
316
317static errno_t ne2k_on_unicast_mode_change(nic_t *nic_data,
318 nic_unicast_mode_t new_mode,
319 const nic_address_t *address_list, size_t address_count)
320{
321 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
322 switch (new_mode) {
323 case NIC_UNICAST_BLOCKED:
324 ne2k_set_promisc_phys(ne2k, false);
325 nic_report_hw_filtering(nic_data, 0, -1, -1);
326 return EOK;
327 case NIC_UNICAST_DEFAULT:
328 ne2k_set_promisc_phys(ne2k, false);
329 nic_report_hw_filtering(nic_data, 1, -1, -1);
330 return EOK;
331 case NIC_UNICAST_LIST:
332 ne2k_set_promisc_phys(ne2k, true);
333 nic_report_hw_filtering(nic_data, 0, -1, -1);
334 return EOK;
335 case NIC_UNICAST_PROMISC:
336 ne2k_set_promisc_phys(ne2k, true);
337 nic_report_hw_filtering(nic_data, 1, -1, -1);
338 return EOK;
339 default:
340 return ENOTSUP;
341 }
342}
343
344static errno_t ne2k_on_multicast_mode_change(nic_t *nic_data,
345 nic_multicast_mode_t new_mode,
346 const nic_address_t *address_list, size_t address_count)
347{
348 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
349 switch (new_mode) {
350 case NIC_MULTICAST_BLOCKED:
351 ne2k_set_accept_mcast(ne2k, false);
352 nic_report_hw_filtering(nic_data, -1, 1, -1);
353 return EOK;
354 case NIC_MULTICAST_LIST:
355 ne2k_set_accept_mcast(ne2k, true);
356 ne2k_set_mcast_hash(ne2k,
357 nic_mcast_hash(address_list, address_count));
358 nic_report_hw_filtering(nic_data, -1, 0, -1);
359 return EOK;
360 case NIC_MULTICAST_PROMISC:
361 ne2k_set_accept_mcast(ne2k, true);
362 ne2k_set_mcast_hash(ne2k, 0xFFFFFFFFFFFFFFFFllu);
363 nic_report_hw_filtering(nic_data, -1, 1, -1);
364 return EOK;
365 default:
366 return ENOTSUP;
367 }
368}
369
370static errno_t ne2k_on_broadcast_mode_change(nic_t *nic_data,
371 nic_broadcast_mode_t new_mode)
372{
373 ne2k_t *ne2k = (ne2k_t *) nic_get_specific(nic_data);
374 switch (new_mode) {
375 case NIC_BROADCAST_BLOCKED:
376 ne2k_set_accept_bcast(ne2k, false);
377 return EOK;
378 case NIC_BROADCAST_ACCEPTED:
379 ne2k_set_accept_bcast(ne2k, true);
380 return EOK;
381 default:
382 return ENOTSUP;
383 }
384}
385
386static errno_t ne2k_dev_add(ddf_dev_t *dev)
387{
388 ddf_fun_t *fun;
389
390 /* Allocate driver data for the device. */
391 nic_t *nic_data = nic_create_and_bind(dev);
392 if (nic_data == NULL)
393 return ENOMEM;
394
395 nic_set_send_frame_handler(nic_data, ne2k_send);
396 nic_set_state_change_handlers(nic_data,
397 ne2k_on_activating, NULL, ne2k_on_stopping);
398 nic_set_filtering_change_handlers(nic_data,
399 ne2k_on_unicast_mode_change, ne2k_on_multicast_mode_change,
400 ne2k_on_broadcast_mode_change, NULL, NULL);
401
402 ne2k_t *ne2k = malloc(sizeof(ne2k_t));
403 if (NULL != ne2k) {
404 memset(ne2k, 0, sizeof(ne2k_t));
405 nic_set_specific(nic_data, ne2k);
406 } else {
407 nic_unbind_and_destroy(dev);
408 return ENOMEM;
409 }
410
411 ne2k->dev = dev;
412 ne2k->parent_sess = ddf_dev_parent_sess_get(dev);
413 if (ne2k->parent_sess == NULL) {
414 ne2k_dev_cleanup(dev);
415 return ENOMEM;
416 }
417
418 errno_t rc = ne2k_dev_init(nic_data);
419 if (rc != EOK) {
420 ne2k_dev_cleanup(dev);
421 return rc;
422 }
423
424 rc = nic_report_address(nic_data, &ne2k->mac);
425 if (rc != EOK) {
426 ne2k_dev_cleanup(dev);
427 return rc;
428 }
429
430 fun = ddf_fun_create(nic_get_ddf_dev(nic_data), fun_exposed, "port0");
431 if (fun == NULL) {
432 ne2k_dev_cleanup(dev);
433 return ENOMEM;
434 }
435
436 nic_set_ddf_fun(nic_data, fun);
437 ddf_fun_set_ops(fun, &ne2k_dev_ops);
438
439 rc = ddf_fun_bind(fun);
440 if (rc != EOK) {
441 ddf_fun_destroy(fun);
442 ne2k_dev_cleanup(dev);
443 return rc;
444 }
445
446 rc = ddf_fun_add_to_category(fun, DEVICE_CATEGORY_NIC);
447 if (rc != EOK) {
448 ddf_fun_unbind(fun);
449 ddf_fun_destroy(fun);
450 return rc;
451 }
452
453 return EOK;
454}
455
456static nic_iface_t ne2k_nic_iface = {
457 .set_address = ne2k_set_address,
458 .get_device_info = ne2k_get_device_info,
459 .get_cable_state = ne2k_get_cable_state,
460 .get_operation_mode = ne2k_get_operation_mode,
461};
462
463static driver_ops_t ne2k_driver_ops = {
464 .dev_add = ne2k_dev_add
465};
466
467static driver_t ne2k_driver = {
468 .name = NAME,
469 .driver_ops = &ne2k_driver_ops
470};
471
472int main(int argc, char *argv[])
473{
474 printf("%s: HelenOS NE 2000 network adapter driver\n", NAME);
475
476 nic_driver_init(NAME);
477 nic_driver_implement(&ne2k_driver_ops, &ne2k_dev_ops, &ne2k_nic_iface);
478
479 return ddf_driver_main(&ne2k_driver);
480}
481
482/** @}
483 */
Note: See TracBrowser for help on using the repository browser.