source: mainline/uspace/drv/nic/rtl8139/driver.c@ f08da1c

Last change on this file since f08da1c was 09ab0a9a, checked in by Jiri Svoboda <jiri@…>, 7 years ago

Fix vertical spacing with new Ccheck revision.
  • Property mode set to 100644
File size: 57.8 KB
Line 
1/*
2 * Copyright (c) 2011 Jiri Michalec
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#include <assert.h>
30#include <async.h>
31#include <errno.h>
32#include <align.h>
33#include <byteorder.h>
34#include <barrier.h>
35#include <as.h>
36#include <ddf/log.h>
37#include <ddf/interrupt.h>
38#include <device/hw_res.h>
39#include <io/log.h>
40#include <nic.h>
41#include <pci_dev_iface.h>
42#include <stdio.h>
43#include <str.h>
44
45#include "defs.h"
46#include "driver.h"
47#include "general.h"
48
49/** Global mutex for work with shared irq structure */
50FIBRIL_MUTEX_INITIALIZE(irq_reg_lock);
51
52/** Lock interrupt structure mutex */
53#define RTL8139_IRQ_STRUCT_LOCK() \
54 fibril_mutex_lock(&irq_reg_lock)
55
56/** Unlock interrupt structure mutex */
57#define RTL8139_IRQ_STRUCT_UNLOCK() \
58 fibril_mutex_unlock(&irq_reg_lock)
59
60/** PCI clock frequency in kHz */
61#define RTL8139_PCI_FREQ_KHZ 33000
62
63#define RTL8139_AUTONEG_CAPS (ETH_AUTONEG_10BASE_T_HALF | \
64 ETH_AUTONEG_10BASE_T_FULL | ETH_AUTONEG_100BASE_TX_HALF | \
65 ETH_AUTONEG_100BASE_TX_FULL | ETH_AUTONEG_PAUSE_SYMETRIC)
66
67/** Lock transmitter and receiver data
68 *
69 * This function shall be called whenever
70 * both transmitter and receiver locking
71 * to force safe lock ordering (deadlock prevention)
72 *
73 * @param rtl8139 RTL8139 private data
74 *
75 */
76inline static void rtl8139_lock_all(rtl8139_t *rtl8139)
77{
78 assert(rtl8139);
79 fibril_mutex_lock(&rtl8139->tx_lock);
80 fibril_mutex_lock(&rtl8139->rx_lock);
81}
82
83/** Unlock transmitter and receiver data
84 *
85 * @param rtl8139 RTL8139 private data
86 *
87 */
88inline static void rtl8139_unlock_all(rtl8139_t *rtl8139)
89{
90 assert(rtl8139);
91 fibril_mutex_unlock(&rtl8139->rx_lock);
92 fibril_mutex_unlock(&rtl8139->tx_lock);
93}
94
95#ifndef RXBUF_SIZE_FLAGS
96/** Flags for receiver buffer - 16kB default */
97#define RXBUF_SIZE_FLAGS RTL8139_RXFLAGS_SIZE_16
98#endif
99
100#if (RXBUF_SIZE_FLAGS > RTL8139_RXFLAGS_SIZE_64) || (RXBUF_SIZE_FLAGS < 0)
101#error Bad receiver buffer flags size flags
102#endif
103
104/** Size of the receiver buffer
105 *
106 * Incrementing flags by one twices the buffer size
107 * the lowest size is 8*1024 (flags = 0)
108 */
109#define RxBUF_SIZE RTL8139_RXSIZE(RXBUF_SIZE_FLAGS)
110
111/** Total size of the receiver buffer to allocate */
112#define RxBUF_TOT_LENGTH RTL8139_RXBUF_LENGTH(RXBUF_SIZE_FLAGS)
113
114/** Default interrupt mask */
115#define RTL_DEFAULT_INTERRUPTS UINT16_C(0xFFFF)
116
117/** Obtain the value of the register part
118 * The bit operations will be done
119 * The _SHIFT and _MASK for the register part must exists as macros
120 * or variables
121 */
122#define REG_GET_VAL(value, reg_part)\
123 (((value) >> reg_part##_SHIFT) & reg_part##_MASK)
124
125/** Set interrupts on controller
126 *
127 * @param rtl8139 The card private structure
128 */
129inline static void rtl8139_hw_int_set(rtl8139_t *rtl8139)
130{
131 pio_write_16(rtl8139->io_port + IMR, rtl8139->int_mask);
132}
133
134/** Check on the controller if the receiving buffer is empty
135 *
136 * @param rtl8139 The controller data
137 *
138 * @return Nonzero if empty, zero otherwise
139 */
140inline static int rtl8139_hw_buffer_empty(rtl8139_t *rtl8139)
141{
142 return pio_read_16(rtl8139->io_port + CR) & CR_BUFE;
143}
144
145/** Update the mask of accepted frames in the RCR register according to
146 * rcr_accept_mode value in rtl8139_t
147 *
148 * @param rtl8139 The rtl8139 private data
149 */
150static void rtl8139_hw_update_rcr(rtl8139_t *rtl8139)
151{
152 uint32_t rcr = rtl8139->rcr_data.rcr_base | rtl8139->rcr_data.ucast_mask |
153 rtl8139->rcr_data.mcast_mask | rtl8139->rcr_data.bcast_mask |
154 rtl8139->rcr_data.defect_mask |
155 (RXBUF_SIZE_FLAGS << RCR_RBLEN_SHIFT);
156
157 ddf_msg(LVL_DEBUG, "Rewriting rcr: %x -> %x", pio_read_32(rtl8139->io_port + RCR),
158 rcr);
159
160 pio_write_32(rtl8139->io_port + RCR, rcr);
161}
162
163/** Fill the mask of accepted multicast frames in the card registers
164 *
165 * @param rtl8139 The rtl8139 private data
166 * @param mask The mask to set
167 */
168inline static void rtl8139_hw_set_mcast_mask(rtl8139_t *rtl8139,
169 uint64_t mask)
170{
171 pio_write_32(rtl8139->io_port + MAR0, (uint32_t) mask);
172 pio_write_32(rtl8139->io_port + MAR0 + sizeof(uint32_t),
173 (uint32_t)(mask >> 32));
174 return;
175}
176
177/** Set PmEn (Power management enable) bit value
178 *
179 * @param rtl8139 rtl8139 card data
180 * @param bit_val If bit_val is zero pmen is set to 0, otherwise pmen is set to 1
181 */
182inline static void rtl8139_hw_pmen_set(rtl8139_t *rtl8139, uint8_t bit_val)
183{
184 uint8_t config1 = pio_read_8(rtl8139->io_port + CONFIG1);
185 uint8_t config1_new;
186 if (bit_val)
187 config1_new = config1 | CONFIG1_PMEn;
188 else
189 config1_new = config1 & ~(uint8_t)(CONFIG1_PMEn);
190
191 if (config1_new == config1)
192 return;
193
194 rtl8139_regs_unlock(rtl8139->io_port);
195 pio_write_8(rtl8139->io_port + CONFIG1, config1_new);
196 rtl8139_regs_lock(rtl8139->io_port);
197
198 async_sess_t *pci_sess =
199 ddf_dev_parent_sess_get(nic_get_ddf_dev(rtl8139->nic_data));
200
201 // XXX: According to the RTL8139C(L) Rev.1.4 datasheet, the entire PCI
202 // Power Management data structure is located at a fixed address 0x50 so
203 // that PME_Status and PME_En find themselves at address 0x55. It would
204 // be more flexible though to locate the data structure by searching
205 // the PCI function's capability list.
206 if (bit_val) {
207 uint8_t pmen;
208 pci_config_space_read_8(pci_sess, 0x55, &pmen);
209 pci_config_space_write_8(pci_sess, 0x55, pmen | 1 | (1 << 7));
210 } else {
211 uint8_t pmen;
212 pci_config_space_read_8(pci_sess, 0x55, &pmen);
213 pci_config_space_write_8(pci_sess, 0x55, pmen & ~(1 | (1 << 7)));
214 }
215}
216
217/** Get MAC address of the RTL8139 adapter
218 *
219 * @param rtl8139 The RTL8139 device
220 * @param address The place to store the address
221 *
222 * @return EOK if succeed, error code otherwise
223 */
224inline static void rtl8139_hw_get_addr(rtl8139_t *rtl8139,
225 nic_address_t *addr)
226{
227 assert(rtl8139);
228 assert(addr);
229
230 uint32_t *mac0_dest = (uint32_t *)addr->address;
231 uint16_t *mac4_dest = (uint16_t *)(addr->address + 4);
232
233 /* Read MAC address from the i/o (4byte + 2byte reads) */
234 *mac0_dest = pio_read_32(rtl8139->io_port + MAC0);
235 *mac4_dest = pio_read_16(rtl8139->io_port + MAC0 + 4);
236}
237
238/** Set MAC address to the device
239 *
240 * @param rtl8139 Controller private structure
241 * @param addr The address to set
242 */
243static void rtl8139_hw_set_addr(rtl8139_t *rtl8139, const nic_address_t *addr)
244{
245 assert(rtl8139);
246 assert(addr);
247
248 const uint32_t *val1 = (const uint32_t *)addr->address;
249 const uint16_t *val2 = (const uint16_t *)(addr->address + sizeof(uint32_t));
250
251 rtl8139_regs_unlock(rtl8139->io_port);
252 pio_write_32(rtl8139->io_port + MAC0, *val1);
253 pio_write_32(rtl8139->io_port + MAC0 + 4, *val2);
254 rtl8139_regs_lock(rtl8139->io_port);
255}
256
257/** Provide OR in the 8bit register (set selected bits to 1)
258 *
259 * @param rtl8139 The rtl8139 structure
260 * @param reg_offset Register offset in the device IO space
261 * @param bits_add The value to or
262 */
263inline static void rtl8139_hw_reg_add_8(rtl8139_t *rtl8139, size_t reg_offset,
264 uint8_t bits_add)
265{
266 uint8_t value = pio_read_8(rtl8139->io_port + reg_offset);
267 value |= bits_add;
268 pio_write_8(rtl8139->io_port + reg_offset, value);
269}
270
271/** Unset selected bits in 8bit register
272 *
273 * @param rtl8139 The rtl8139 structure
274 * @param reg_offset Register offset in the device IO space
275 * @param bits_add The mask of bits to remove
276 */
277inline static void rtl8139_hw_reg_rem_8(rtl8139_t *rtl8139, size_t reg_offset,
278 uint8_t bits_add)
279{
280 uint8_t value = pio_read_8(rtl8139->io_port + reg_offset);
281 value &= ~bits_add;
282 pio_write_8(rtl8139->io_port + reg_offset, value);
283}
284
285static errno_t rtl8139_set_addr(ddf_fun_t *fun, const nic_address_t *);
286static errno_t rtl8139_get_device_info(ddf_fun_t *fun, nic_device_info_t *info);
287static errno_t rtl8139_get_cable_state(ddf_fun_t *fun, nic_cable_state_t *state);
288static errno_t rtl8139_get_operation_mode(ddf_fun_t *fun, int *speed,
289 nic_channel_mode_t *duplex, nic_role_t *role);
290static errno_t rtl8139_set_operation_mode(ddf_fun_t *fun, int speed,
291 nic_channel_mode_t duplex, nic_role_t);
292
293static errno_t rtl8139_pause_get(ddf_fun_t *, nic_result_t *, nic_result_t *,
294 uint16_t *);
295static errno_t rtl8139_pause_set(ddf_fun_t *, int, int, uint16_t);
296
297static errno_t rtl8139_autoneg_enable(ddf_fun_t *fun, uint32_t advertisement);
298static errno_t rtl8139_autoneg_disable(ddf_fun_t *fun);
299static errno_t rtl8139_autoneg_probe(ddf_fun_t *fun, uint32_t *our_advertisement,
300 uint32_t *their_advertisement, nic_result_t *result,
301 nic_result_t *their_result);
302static errno_t rtl8139_autoneg_restart(ddf_fun_t *fun);
303
304static errno_t rtl8139_defective_get_mode(ddf_fun_t *fun, uint32_t *mode);
305static errno_t rtl8139_defective_set_mode(ddf_fun_t *fun, uint32_t mode);
306
307static errno_t rtl8139_wol_virtue_add(nic_t *nic_data,
308 const nic_wol_virtue_t *virtue);
309static void rtl8139_wol_virtue_rem(nic_t *nic_data,
310 const nic_wol_virtue_t *virtue);
311
312static errno_t rtl8139_poll_mode_change(nic_t *nic_data, nic_poll_mode_t mode,
313 const struct timespec *period);
314static void rtl8139_poll(nic_t *nic_data);
315
316/** Network interface options for RTL8139 card driver */
317static nic_iface_t rtl8139_nic_iface = {
318 .set_address = &rtl8139_set_addr,
319 .get_device_info = &rtl8139_get_device_info,
320 .get_cable_state = &rtl8139_get_cable_state,
321 .get_operation_mode = &rtl8139_get_operation_mode,
322 .set_operation_mode = &rtl8139_set_operation_mode,
323
324 .get_pause = &rtl8139_pause_get,
325 .set_pause = &rtl8139_pause_set,
326
327 .autoneg_enable = &rtl8139_autoneg_enable,
328 .autoneg_disable = &rtl8139_autoneg_disable,
329 .autoneg_probe = &rtl8139_autoneg_probe,
330 .autoneg_restart = &rtl8139_autoneg_restart,
331
332 .defective_get_mode = &rtl8139_defective_get_mode,
333 .defective_set_mode = &rtl8139_defective_set_mode,
334};
335
336/** Basic device operations for RTL8139 driver */
337static ddf_dev_ops_t rtl8139_dev_ops;
338
339static errno_t rtl8139_dev_add(ddf_dev_t *dev);
340
341/** Basic driver operations for RTL8139 driver */
342static driver_ops_t rtl8139_driver_ops = {
343 .dev_add = &rtl8139_dev_add,
344};
345
346/** Driver structure for RTL8139 driver */
347static driver_t rtl8139_driver = {
348 .name = NAME,
349 .driver_ops = &rtl8139_driver_ops
350};
351
352/* The default implementation callbacks */
353static errno_t rtl8139_on_activated(nic_t *nic_data);
354static errno_t rtl8139_on_stopped(nic_t *nic_data);
355static void rtl8139_send_frame(nic_t *nic_data, void *data, size_t size);
356
357/** Check if the transmit buffer is busy */
358#define rtl8139_tbuf_busy(tsd) ((pio_read_32(tsd) & TSD_OWN) == 0)
359
360/** Send frame with the hardware
361 *
362 * note: the main_lock is locked when framework calls this function
363 *
364 * @param nic_data The nic driver data structure
365 * @param data Frame data
366 * @param size Frame size in bytes
367 *
368 * @return EOK if succeed, error code in the case of error
369 */
370static void rtl8139_send_frame(nic_t *nic_data, void *data, size_t size)
371{
372 assert(nic_data);
373
374 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
375 assert(rtl8139);
376 ddf_msg(LVL_DEBUG, "Sending frame");
377
378 if (size > RTL8139_FRAME_MAX_LENGTH) {
379 ddf_msg(LVL_ERROR, "Send frame: frame too long, %zu bytes",
380 size);
381 nic_report_send_error(rtl8139->nic_data, NIC_SEC_OTHER, 1);
382 goto err_size;
383 }
384
385 assert((size & TSD_SIZE_MASK) == size);
386
387 /* Lock transmitter structure for obtaining next buffer */
388 fibril_mutex_lock(&rtl8139->tx_lock);
389
390 /* Check if there is free buffer */
391 if (rtl8139->tx_next - TX_BUFF_COUNT == rtl8139->tx_used) {
392 nic_set_tx_busy(nic_data, 1);
393 fibril_mutex_unlock(&rtl8139->tx_lock);
394 nic_report_send_error(nic_data, NIC_SEC_BUFFER_FULL, 1);
395 goto err_busy_no_inc;
396 }
397
398 /* Get buffer id to use and set next buffer to use */
399 size_t tx_curr = rtl8139->tx_next++ % TX_BUFF_COUNT;
400
401 fibril_mutex_unlock(&rtl8139->tx_lock);
402
403 /* Get address of the buffer descriptor and frame data */
404 void *tsd = rtl8139->io_port + TSD0 + tx_curr * 4;
405 void *buf_addr = rtl8139->tx_buff[tx_curr];
406
407 /* Wait until the buffer is free */
408 assert(!rtl8139_tbuf_busy(tsd));
409
410 /* Write frame data to the buffer, set the size to TSD and clear OWN bit */
411 memcpy(buf_addr, data, size);
412
413 /* Set size of the data to send */
414 uint32_t tsd_value = pio_read_32(tsd);
415 tsd_value = rtl8139_tsd_set_size(tsd_value, size);
416 pio_write_32(tsd, tsd_value);
417
418 /* barrier for HW to really see the current buffer data */
419 write_barrier();
420
421 tsd_value &= ~(uint32_t)TSD_OWN;
422 pio_write_32(tsd, tsd_value);
423 return;
424
425err_busy_no_inc:
426err_size:
427 return;
428}
429
430/** Reset the controller
431 *
432 * @param io_base The address of the i/o port mapping start
433 */
434inline static void rtl8139_hw_soft_reset(void *io_base)
435{
436 pio_write_8(io_base + CR, CR_RST);
437 memory_barrier();
438 while (pio_read_8(io_base + CR) & CR_RST) {
439 fibril_usleep(1);
440 read_barrier();
441 }
442}
443
444/** Provide soft reset of the controller
445 *
446 * The caller must lock tx_lock and rx_lock before calling this function
447 *
448 */
449static void rtl8139_soft_reset(rtl8139_t *rtl8139)
450{
451 assert(rtl8139);
452
453 rtl8139_hw_soft_reset(rtl8139->io_port);
454 nic_t *nic_data = rtl8139->nic_data;
455
456 /* Write MAC address to the card */
457 nic_address_t addr;
458 nic_query_address(nic_data, &addr);
459 rtl8139_hw_set_addr(rtl8139, &addr);
460
461 /* Recover accept modes back */
462 rtl8139_hw_set_mcast_mask(rtl8139, nic_query_mcast_hash(nic_data));
463 rtl8139_hw_update_rcr(rtl8139);
464
465 rtl8139->tx_used = 0;
466 rtl8139->tx_next = 0;
467 nic_set_tx_busy(rtl8139->nic_data, 0);
468}
469
470/** Create frame structure from the buffer data
471 *
472 * @param nic_data NIC driver data
473 * @param rx_buffer The receiver buffer
474 * @param rx_size The buffer size
475 * @param frame_start The offset where packet data start
476 * @param frame_size The size of the frame data
477 *
478 * @return The frame list node (not connected)
479 *
480 */
481static nic_frame_t *rtl8139_read_frame(nic_t *nic_data,
482 void *rx_buffer, size_t rx_size, size_t frame_start, size_t frame_size)
483{
484 nic_frame_t *frame = nic_alloc_frame(nic_data, frame_size);
485 if (!frame) {
486 ddf_msg(LVL_ERROR, "Can not allocate frame for received frame.");
487 return NULL;
488 }
489
490 void *ret = rtl8139_memcpy_wrapped(frame->data, rx_buffer, frame_start,
491 RxBUF_SIZE, frame_size);
492 if (ret == NULL) {
493 nic_release_frame(nic_data, frame);
494 return NULL;
495 }
496 return frame;
497}
498
499/*
500 * Reset receiver
501 *
502 * Use in the case of receiver error (lost in the rx_buff)
503 *
504 * @param rtl8139 controller private data
505 */
506static void rtl8139_rx_reset(rtl8139_t *rtl8139)
507{
508 /* Disable receiver, update offset and enable receiver again */
509 uint8_t cr = pio_read_8(rtl8139->io_port + CR);
510 rtl8139_regs_unlock(rtl8139);
511
512 pio_write_8(rtl8139->io_port + CR, cr & ~(uint8_t)CR_RE);
513
514 write_barrier();
515 pio_write_32(rtl8139->io_port + CAPR, 0);
516 pio_write_32(rtl8139->io_port + RBSTART,
517 PTR2U32(rtl8139->rx_buff_phys));
518
519 write_barrier();
520
521 rtl8139_hw_update_rcr(rtl8139);
522 pio_write_8(rtl8139->io_port + CR, cr);
523 rtl8139_regs_lock(rtl8139);
524
525 nic_report_receive_error(rtl8139->nic_data, NIC_REC_OTHER, 1);
526}
527
528/** Receive all frames in queue
529 *
530 * @param nic_data The controller data
531 * @return The linked list of nic_frame_list_t nodes, each containing one frame
532 */
533static nic_frame_list_t *rtl8139_frame_receive(nic_t *nic_data)
534{
535 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
536 if (rtl8139_hw_buffer_empty(rtl8139))
537 return NULL;
538
539 nic_frame_list_t *frames = nic_alloc_frame_list();
540 if (!frames)
541 ddf_msg(LVL_ERROR, "Can not allocate frame list for received frames.");
542
543 void *rx_buffer = rtl8139->rx_buff_virt;
544
545 /* where to start reading */
546 uint16_t rx_offset = pio_read_16(rtl8139->io_port + CAPR) + 16;
547 /* unread bytes count */
548 uint16_t bytes_received = pio_read_16(rtl8139->io_port + CBA);
549 uint16_t max_read;
550 uint16_t cur_read = 0;
551
552 /* get values to the <0, buffer size) */
553 bytes_received %= RxBUF_SIZE;
554 rx_offset %= RxBUF_SIZE;
555
556 /* count how many bytes to read maximaly */
557 if (bytes_received < rx_offset)
558 max_read = bytes_received + (RxBUF_SIZE - rx_offset);
559 else
560 max_read = bytes_received - rx_offset;
561
562 memory_barrier();
563 while (!rtl8139_hw_buffer_empty(rtl8139)) {
564 void *rx_ptr = rx_buffer + rx_offset % RxBUF_SIZE;
565 uint32_t frame_header = uint32_t_le2host(*((uint32_t *)rx_ptr));
566 uint16_t size = frame_header >> 16;
567 uint16_t frame_size = size - RTL8139_CRC_SIZE;
568 /* received frame flags in frame header */
569 uint16_t rcs = (uint16_t) frame_header;
570
571 if (size == RTL8139_EARLY_SIZE) {
572 /* The frame copying is still in progress, break receiving */
573 ddf_msg(LVL_DEBUG, "Early threshold reached, not completely coppied");
574 break;
575 }
576
577 /* Check if the header is valid, otherwise we are lost in the buffer */
578 if (size == 0 || size > RTL8139_FRAME_MAX_LENGTH) {
579 ddf_msg(LVL_ERROR, "Receiver error -> receiver reset (size: %4" PRIu16 ", "
580 "header 0x%4" PRIx32 ". Offset: %" PRIu16 ")", size, frame_header,
581 rx_offset);
582 goto rx_err;
583 }
584 if (size < RTL8139_RUNT_MAX_SIZE && !(rcs & RSR_RUNT)) {
585 ddf_msg(LVL_ERROR, "Receiver error -> receiver reset (%" PRIx16 ")", size);
586 goto rx_err;
587 }
588
589 cur_read += size + RTL_FRAME_HEADER_SIZE;
590 if (cur_read > max_read)
591 break;
592
593 if (frames) {
594 nic_frame_t *frame = rtl8139_read_frame(nic_data, rx_buffer,
595 RxBUF_SIZE, rx_offset + RTL_FRAME_HEADER_SIZE, frame_size);
596
597 if (frame)
598 nic_frame_list_append(frames, frame);
599 }
600
601 /* Update offset */
602 rx_offset = ALIGN_UP(rx_offset + size + RTL_FRAME_HEADER_SIZE, 4);
603
604 /*
605 * Write lesser value to prevent overflow into unread frame
606 * (the recomendation from the RealTech rtl8139 programming guide)
607 */
608 uint16_t capr_val = rx_offset - 16;
609 pio_write_16(rtl8139->io_port + CAPR, capr_val);
610
611 /* Ensure no CR read optimalization during next empty buffer test */
612 memory_barrier();
613 }
614 return frames;
615rx_err:
616 rtl8139_rx_reset(rtl8139);
617 return frames;
618}
619
620irq_pio_range_t rtl8139_irq_pio_ranges[] = {
621 {
622 .base = 0,
623 .size = RTL8139_IO_SIZE
624 }
625};
626
627/** Commands to deal with interrupt
628 *
629 * Read ISR, check if tere is any interrupt pending.
630 * If so, reset it and accept the interrupt.
631 * The .addr of the first and third command must
632 * be filled to the ISR port address
633 */
634irq_cmd_t rtl8139_irq_commands[] = {
635 {
636 /* Get the interrupt status */
637 .cmd = CMD_PIO_READ_16,
638 .addr = NULL,
639 .dstarg = 2
640 },
641 {
642 .cmd = CMD_PREDICATE,
643 .value = 3,
644 .srcarg = 2
645 },
646 {
647 /* Mark interrupts as solved */
648 .cmd = CMD_PIO_WRITE_16,
649 .addr = NULL,
650 .value = 0xFFFF
651 },
652 {
653 /* Disable interrupts until interrupt routine is finished */
654 .cmd = CMD_PIO_WRITE_16,
655 .addr = NULL,
656 .value = 0x0000
657 },
658 {
659 .cmd = CMD_ACCEPT
660 }
661};
662
663/** Interrupt code definition */
664irq_code_t rtl8139_irq_code = {
665 .rangecount = sizeof(rtl8139_irq_pio_ranges) / sizeof(irq_pio_range_t),
666 .ranges = rtl8139_irq_pio_ranges,
667 .cmdcount = sizeof(rtl8139_irq_commands) / sizeof(irq_cmd_t),
668 .cmds = rtl8139_irq_commands
669};
670
671/** Deal with transmitter interrupt
672 *
673 * @param nic_data Nic driver data
674 */
675static void rtl8139_tx_interrupt(nic_t *nic_data)
676{
677 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
678
679 fibril_mutex_lock(&rtl8139->tx_lock);
680
681 size_t tx_next = rtl8139->tx_next;
682 size_t tx_used = rtl8139->tx_used;
683 while (tx_used != tx_next) {
684 size_t desc_to_check = tx_used % TX_BUFF_COUNT;
685 void *tsd_to_check = rtl8139->io_port + TSD0 +
686 desc_to_check * sizeof(uint32_t);
687 uint32_t tsd_value = pio_read_32(tsd_to_check);
688
689 /* If sending is still in the progress */
690 if ((tsd_value & TSD_OWN) == 0)
691 break;
692
693 tx_used++;
694
695 /* If the frame was sent */
696 if (tsd_value & TSD_TOK) {
697 size_t size = REG_GET_VAL(tsd_value, TSD_SIZE);
698 nic_report_send_ok(nic_data, 1, size);
699 } else if (tsd_value & TSD_CRS) {
700 nic_report_send_error(nic_data, NIC_SEC_CARRIER_LOST, 1);
701 } else if (tsd_value & TSD_OWC) {
702 nic_report_send_error(nic_data, NIC_SEC_WINDOW_ERROR, 1);
703 } else if (tsd_value & TSD_TABT) {
704 nic_report_send_error(nic_data, NIC_SEC_ABORTED, 1);
705 } else if (tsd_value & TSD_CDH) {
706 nic_report_send_error(nic_data, NIC_SEC_HEARTBEAT, 1);
707 }
708
709 unsigned collisions = REG_GET_VAL(tsd_value, TSD_NCC);
710 if (collisions > 0) {
711 nic_report_collisions(nic_data, collisions);
712 }
713
714 if (tsd_value & TSD_TUN) {
715 nic_report_send_error(nic_data, NIC_SEC_FIFO_OVERRUN, 1);
716 }
717 }
718 if (rtl8139->tx_used != tx_used) {
719 rtl8139->tx_used = tx_used;
720 nic_set_tx_busy(nic_data, 0);
721 }
722 fibril_mutex_unlock(&rtl8139->tx_lock);
723}
724
725/** Receive all frames from the buffer
726 *
727 * @param rtl8139 driver private data
728 */
729static void rtl8139_receive_frames(nic_t *nic_data)
730{
731 assert(nic_data);
732
733 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
734 assert(rtl8139);
735
736 fibril_mutex_lock(&rtl8139->rx_lock);
737 nic_frame_list_t *frames = rtl8139_frame_receive(nic_data);
738 fibril_mutex_unlock(&rtl8139->rx_lock);
739
740 if (frames)
741 nic_received_frame_list(nic_data, frames);
742}
743
744/** Deal with poll interrupt
745 *
746 * @param nic_data Nic driver data
747 */
748static int rtl8139_poll_interrupt(nic_t *nic_data)
749{
750 assert(nic_data);
751
752 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
753 assert(rtl8139);
754
755 uint32_t timer_val;
756 int receive = rtl8139_timer_act_step(&rtl8139->poll_timer, &timer_val);
757
758 assert(timer_val);
759 pio_write_32(rtl8139->io_port + TIMERINT, timer_val);
760 pio_write_32(rtl8139->io_port + TCTR, 0x0);
761 ddf_msg(LVL_DEBUG, "rtl8139 timer: %" PRIu32 "\treceive: %d", timer_val, receive);
762 return receive;
763}
764
765/** Poll device according to isr status
766 *
767 * The isr value must be obtained and cleared by the caller. The reason
768 * of this function separate is to allow polling from both interrupt
769 * (which clears controller ISR before the handler runs) and the polling
770 * callbacks.
771 *
772 * @param nic_data Driver data
773 * @param isr Interrupt status register value
774 */
775static void rtl8139_interrupt_impl(nic_t *nic_data, uint16_t isr)
776{
777 assert(nic_data);
778
779 nic_poll_mode_t poll_mode = nic_query_poll_mode(nic_data, 0);
780
781 /* Process only when should in the polling mode */
782 if (poll_mode == NIC_POLL_PERIODIC) {
783 int receive = 0;
784 if (isr & INT_TIME_OUT) {
785 receive = rtl8139_poll_interrupt(nic_data);
786 }
787 if (!receive)
788 return;
789 }
790
791 /*
792 * Check transmittion interrupts first to allow transmit next frames
793 * sooner
794 */
795 if (isr & (INT_TOK | INT_TER)) {
796 rtl8139_tx_interrupt(nic_data);
797 }
798 if (isr & INT_ROK) {
799 rtl8139_receive_frames(nic_data);
800 }
801 if (isr & (INT_RER | INT_RXOVW | INT_FIFOOVW)) {
802 if (isr & INT_RER) {
803 //TODO: is this only the general error, or any particular?
804 }
805 if (isr & (INT_FIFOOVW)) {
806 nic_report_receive_error(nic_data, NIC_REC_FIFO_OVERRUN, 1);
807 } else if (isr & (INT_RXOVW)) {
808 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
809 assert(rtl8139);
810
811 uint32_t miss = pio_read_32(rtl8139->io_port + MPC) & MPC_VMASK;
812 pio_write_32(rtl8139->io_port + MPC, 0);
813 nic_report_receive_error(nic_data, NIC_REC_BUFFER_OVERFLOW, miss);
814 }
815 }
816}
817
818/** Handle device interrupt
819 *
820 * @param icall The IPC call structure
821 * @param dev The rtl8139 device
822 *
823 */
824static void rtl8139_interrupt_handler(ipc_call_t *icall, ddf_dev_t *dev)
825{
826 assert(dev);
827 assert(icall);
828
829 uint16_t isr = (uint16_t) IPC_GET_ARG2(*icall);
830 nic_t *nic_data = nic_get_from_ddf_dev(dev);
831 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
832
833 rtl8139_interrupt_impl(nic_data, isr);
834
835 /* Turn the interrupts on again */
836 rtl8139_hw_int_set(rtl8139);
837}
838
839/** Register interrupt handler for the card in the system
840 *
841 * Note: the global irq_reg_mutex is locked because of work with global
842 * structure.
843 *
844 * @param nic_data The driver data
845 *
846 * @param[out] handle IRQ capability handle if the handler was registered.
847 *
848 * @return An error code otherwise.
849 */
850inline static errno_t rtl8139_register_int_handler(nic_t *nic_data,
851 cap_irq_handle_t *handle)
852{
853 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
854
855 /* Lock the mutex in whole driver while working with global structure */
856 RTL8139_IRQ_STRUCT_LOCK();
857
858 rtl8139_irq_code.ranges[0].base = (uintptr_t) rtl8139->io_addr;
859 rtl8139_irq_code.cmds[0].addr = rtl8139->io_addr + ISR;
860 rtl8139_irq_code.cmds[2].addr = rtl8139->io_addr + ISR;
861 rtl8139_irq_code.cmds[3].addr = rtl8139->io_addr + IMR;
862 errno_t rc = register_interrupt_handler(nic_get_ddf_dev(nic_data),
863 rtl8139->irq, rtl8139_interrupt_handler, &rtl8139_irq_code, handle);
864
865 RTL8139_IRQ_STRUCT_UNLOCK();
866
867 return rc;
868}
869
870/** Start the controller
871 *
872 * The caller must lock tx_lock and rx_lock before calling this function
873 *
874 * @param rtl8139 The card private data
875 */
876inline static void rtl8139_card_up(rtl8139_t *rtl8139)
877{
878 void *io_base = rtl8139->io_port;
879 size_t i;
880
881 /* Wake up the device */
882 pio_write_8(io_base + CONFIG1, 0x00);
883 /* Reset the device */
884 rtl8139_soft_reset(rtl8139);
885
886 /* Write transmittion buffer addresses */
887 for (i = 0; i < TX_BUFF_COUNT; ++i) {
888 uint32_t addr = PTR2U32(rtl8139->tx_buff_phys + i * TX_BUFF_SIZE);
889 pio_write_32(io_base + TSAD0 + 4 * i, addr);
890 }
891 rtl8139->tx_next = 0;
892 rtl8139->tx_used = 0;
893 nic_set_tx_busy(rtl8139->nic_data, 0);
894
895 pio_write_32(io_base + RBSTART, PTR2U32(rtl8139->rx_buff_phys));
896
897 /* Enable transmitter and receiver */
898 uint8_t cr_value = pio_read_8(io_base + CR);
899 pio_write_8(io_base + CR, cr_value | CR_TE | CR_RE);
900 rtl8139_hw_update_rcr(rtl8139);
901}
902
903/** Activate the device to receive and transmit frames
904 *
905 * @param nic_data The nic driver data
906 *
907 * @return EOK if activated successfully, error code otherwise
908 */
909static errno_t rtl8139_on_activated(nic_t *nic_data)
910{
911 assert(nic_data);
912 ddf_msg(LVL_NOTE, "Activating device");
913
914 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
915 assert(rtl8139);
916
917 rtl8139_lock_all(rtl8139);
918 rtl8139_card_up(rtl8139);
919 rtl8139_unlock_all(rtl8139);
920
921 rtl8139->int_mask = RTL_DEFAULT_INTERRUPTS;
922 rtl8139_hw_int_set(rtl8139);
923
924 errno_t rc = hw_res_enable_interrupt(rtl8139->parent_sess, rtl8139->irq);
925 if (rc != EOK) {
926 rtl8139_on_stopped(nic_data);
927 return rc;
928 }
929
930 ddf_msg(LVL_DEBUG, "Device activated, interrupt %d registered", rtl8139->irq);
931 return EOK;
932}
933
934/** Callback for NIC_STATE_STOPPED change
935 *
936 * @param nic_data The nic driver data
937 *
938 * @return EOK if succeed, error code otherwise
939 */
940static errno_t rtl8139_on_stopped(nic_t *nic_data)
941{
942 assert(nic_data);
943
944 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
945 assert(rtl8139);
946
947 rtl8139->rcr_data.ucast_mask = RTL8139_RCR_UCAST_DEFAULT;
948 rtl8139->rcr_data.mcast_mask = RTL8139_RCR_MCAST_DEFAULT;
949 rtl8139->rcr_data.bcast_mask = RTL8139_RCR_BCAST_DEFAULT;
950 rtl8139->rcr_data.defect_mask = RTL8139_RCR_DEFECT_DEFAULT;
951
952 /* Reset the card to the initial state (interrupts, Tx and Rx disabled) */
953 rtl8139_lock_all(rtl8139);
954 rtl8139_soft_reset(rtl8139);
955 rtl8139_unlock_all(rtl8139);
956 return EOK;
957}
958
959static errno_t rtl8139_unicast_set(nic_t *nic_data, nic_unicast_mode_t mode,
960 const nic_address_t *, size_t);
961static errno_t rtl8139_multicast_set(nic_t *nic_data, nic_multicast_mode_t mode,
962 const nic_address_t *addr, size_t addr_count);
963static errno_t rtl8139_broadcast_set(nic_t *nic_data, nic_broadcast_mode_t mode);
964
965/** Create driver data structure
966 *
967 * @return Intialized device data structure or NULL
968 */
969static rtl8139_t *rtl8139_create_dev_data(ddf_dev_t *dev)
970{
971 assert(dev);
972 assert(!nic_get_from_ddf_dev(dev));
973
974 nic_t *nic_data = nic_create_and_bind(dev);
975 if (!nic_data)
976 return NULL;
977
978 rtl8139_t *rtl8139 = calloc(1, sizeof(rtl8139_t));
979 if (!rtl8139) {
980 nic_unbind_and_destroy(dev);
981 return NULL;
982 }
983
984 rtl8139->dev = dev;
985
986 rtl8139->nic_data = nic_data;
987 nic_set_specific(nic_data, rtl8139);
988 nic_set_send_frame_handler(nic_data, rtl8139_send_frame);
989 nic_set_state_change_handlers(nic_data,
990 rtl8139_on_activated, NULL, rtl8139_on_stopped);
991 nic_set_filtering_change_handlers(nic_data,
992 rtl8139_unicast_set, rtl8139_multicast_set, rtl8139_broadcast_set,
993 NULL, NULL);
994 nic_set_wol_virtue_change_handlers(nic_data,
995 rtl8139_wol_virtue_add, rtl8139_wol_virtue_rem);
996 nic_set_poll_handlers(nic_data, rtl8139_poll_mode_change, rtl8139_poll);
997
998 fibril_mutex_initialize(&rtl8139->rx_lock);
999 fibril_mutex_initialize(&rtl8139->tx_lock);
1000
1001 nic_set_wol_max_caps(nic_data, NIC_WV_BROADCAST, 1);
1002 nic_set_wol_max_caps(nic_data, NIC_WV_LINK_CHANGE, 1);
1003 nic_set_wol_max_caps(nic_data, NIC_WV_MAGIC_PACKET, 1);
1004
1005 return rtl8139;
1006}
1007
1008/** Clean up the rtl8139 device structure.
1009 *
1010 * @param dev The device structure.
1011 */
1012static void rtl8139_dev_cleanup(ddf_dev_t *dev)
1013{
1014 assert(dev);
1015
1016 if (ddf_dev_data_get(dev))
1017 nic_unbind_and_destroy(dev);
1018}
1019
1020/** Fill the irq and io_addr part of device data structure
1021 *
1022 * The hw_resources must be obtained before calling this function
1023 *
1024 * @param dev The device structure
1025 * @param hw_resources Devices hardware resources
1026 *
1027 * @return EOK if succeed, error code otherwise
1028 */
1029static errno_t rtl8139_fill_resource_info(ddf_dev_t *dev, const hw_res_list_parsed_t
1030 *hw_resources)
1031{
1032 assert(dev);
1033 assert(hw_resources);
1034
1035 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_dev(dev));
1036 assert(rtl8139);
1037
1038 if (hw_resources->irqs.count != 1) {
1039 ddf_msg(LVL_ERROR, "%s device: unexpected irq count", ddf_dev_get_name(dev));
1040 return EINVAL;
1041 }
1042 if (hw_resources->io_ranges.count != 1) {
1043 ddf_msg(LVL_ERROR, "%s device: unexpected io ranges count", ddf_dev_get_name(dev));
1044 return EINVAL;
1045 }
1046
1047 rtl8139->irq = hw_resources->irqs.irqs[0];
1048 ddf_msg(LVL_DEBUG, "%s device: irq 0x%x assigned", ddf_dev_get_name(dev), rtl8139->irq);
1049
1050 rtl8139->io_addr = IOADDR_TO_PTR(RNGABS(hw_resources->io_ranges.ranges[0]));
1051 if (hw_resources->io_ranges.ranges[0].size < RTL8139_IO_SIZE) {
1052 ddf_msg(LVL_ERROR, "i/o range assigned to the device "
1053 "%s is too small.", ddf_dev_get_name(dev));
1054 return EINVAL;
1055 }
1056 ddf_msg(LVL_DEBUG, "%s device: i/o addr %p assigned.", ddf_dev_get_name(dev), rtl8139->io_addr);
1057
1058 return EOK;
1059}
1060
1061/** Obtain information about hardware resources of the device
1062 *
1063 * The device must be connected to the parent
1064 *
1065 * @param dev The device structure
1066 *
1067 * @return EOK if succeed, error code otherwise
1068 */
1069static errno_t rtl8139_get_resource_info(ddf_dev_t *dev)
1070{
1071 assert(dev);
1072
1073 nic_t *nic_data = nic_get_from_ddf_dev(dev);
1074 assert(nic_data);
1075
1076 hw_res_list_parsed_t hw_res_parsed;
1077 hw_res_list_parsed_init(&hw_res_parsed);
1078
1079 /* Get hw resources form parent driver */
1080 errno_t rc = nic_get_resources(nic_data, &hw_res_parsed);
1081 if (rc != EOK)
1082 return rc;
1083
1084 /* Fill resources information to the device */
1085 errno_t ret = rtl8139_fill_resource_info(dev, &hw_res_parsed);
1086 hw_res_list_parsed_clean(&hw_res_parsed);
1087
1088 return ret;
1089}
1090
1091/** Allocate buffers using DMA framework
1092 *
1093 * The buffers structures in the device specific data is filled
1094 *
1095 * @param data The device specific structure to fill
1096 *
1097 * @return EOK in the case of success, error code otherwise
1098 */
1099static errno_t rtl8139_buffers_create(rtl8139_t *rtl8139)
1100{
1101 size_t i = 0;
1102 errno_t rc;
1103
1104 ddf_msg(LVL_DEBUG, "Creating buffers");
1105
1106 rtl8139->tx_buff_virt = AS_AREA_ANY;
1107 rc = dmamem_map_anonymous(TX_PAGES * PAGE_SIZE, DMAMEM_4GiB,
1108 AS_AREA_WRITE, 0, &rtl8139->tx_buff_phys, &rtl8139->tx_buff_virt);
1109 if (rc != EOK) {
1110 ddf_msg(LVL_ERROR, "Can not allocate transmitter buffers.");
1111 goto err_tx_alloc;
1112 }
1113
1114 for (i = 0; i < TX_BUFF_COUNT; ++i)
1115 rtl8139->tx_buff[i] = rtl8139->tx_buff_virt + i * TX_BUFF_SIZE;
1116
1117 ddf_msg(LVL_DEBUG, "The transmittion buffers allocated");
1118
1119 /* Use the first buffer for next transmittion */
1120 rtl8139->tx_next = 0;
1121 rtl8139->tx_used = 0;
1122
1123 /* Allocate buffer for receiver */
1124 ddf_msg(LVL_DEBUG, "Allocating receiver buffer of the size %d bytes",
1125 RxBUF_TOT_LENGTH);
1126
1127 rtl8139->rx_buff_virt = AS_AREA_ANY;
1128 rc = dmamem_map_anonymous(RxBUF_TOT_LENGTH, DMAMEM_4GiB,
1129 AS_AREA_READ, 0, &rtl8139->rx_buff_phys, &rtl8139->rx_buff_virt);
1130 if (rc != EOK) {
1131 ddf_msg(LVL_ERROR, "Can not allocate receive buffer.");
1132 goto err_rx_alloc;
1133 }
1134 ddf_msg(LVL_DEBUG, "The buffers created");
1135
1136 return EOK;
1137
1138err_rx_alloc:
1139 dmamem_unmap_anonymous(rtl8139->tx_buff_virt);
1140err_tx_alloc:
1141 return rc;
1142}
1143
1144/** Initialize the rtl8139 device structure
1145 *
1146 * @param dev The device information
1147 *
1148 * @return EOK if succeed, error code otherwise
1149 */
1150static errno_t rtl8139_device_initialize(ddf_dev_t *dev)
1151{
1152 ddf_msg(LVL_DEBUG, "rtl8139_dev_initialize %s", ddf_dev_get_name(dev));
1153
1154 errno_t ret = EOK;
1155
1156 ddf_msg(LVL_DEBUG, "rtl8139: creating device data");
1157
1158 /* Allocate driver data for the device. */
1159 rtl8139_t *rtl8139 = rtl8139_create_dev_data(dev);
1160 if (rtl8139 == NULL) {
1161 ddf_msg(LVL_ERROR, "Not enough memory for initializing %s.", ddf_dev_get_name(dev));
1162 return ENOMEM;
1163 }
1164
1165 ddf_msg(LVL_DEBUG, "rtl8139: dev_data created");
1166 rtl8139->parent_sess = ddf_dev_parent_sess_get(dev);
1167 if (rtl8139->parent_sess == NULL) {
1168 ddf_msg(LVL_ERROR, "Error connecting parent device.");
1169 return EIO;
1170 }
1171
1172 /* Obtain and fill hardware resources info and connect to parent */
1173 ret = rtl8139_get_resource_info(dev);
1174 if (ret != EOK) {
1175 ddf_msg(LVL_ERROR, "Can not obatin hw resources information");
1176 goto failed;
1177 }
1178
1179 ddf_msg(LVL_DEBUG, "rtl8139: resource_info obtained");
1180
1181 /* Allocate DMA buffers */
1182 ret = rtl8139_buffers_create(rtl8139);
1183 if (ret != EOK)
1184 goto failed;
1185
1186 /* Set default frame acceptance */
1187 rtl8139->rcr_data.ucast_mask = RTL8139_RCR_UCAST_DEFAULT;
1188 rtl8139->rcr_data.mcast_mask = RTL8139_RCR_MCAST_DEFAULT;
1189 rtl8139->rcr_data.bcast_mask = RTL8139_RCR_BCAST_DEFAULT;
1190 rtl8139->rcr_data.defect_mask = RTL8139_RCR_DEFECT_DEFAULT;
1191 /* Set receiver early treshold to 8/16 of frame length */
1192 rtl8139->rcr_data.rcr_base = (0x8 << RCR_ERTH_SHIFT);
1193
1194 ddf_msg(LVL_DEBUG, "The device is initialized");
1195 return ret;
1196
1197failed:
1198 ddf_msg(LVL_ERROR, "The device initialization failed");
1199 rtl8139_dev_cleanup(dev);
1200 return ret;
1201}
1202
1203/** Enable the i/o ports of the device.
1204 *
1205 * @param dev The RTL8139 device.
1206 *
1207 * @return EOK if successed, error code otherwise
1208 */
1209static errno_t rtl8139_pio_enable(ddf_dev_t *dev)
1210{
1211 ddf_msg(LVL_DEBUG, NAME ": rtl8139_pio_enable %s", ddf_dev_get_name(dev));
1212
1213 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_dev(dev));
1214
1215 /* Gain control over port's registers. */
1216 if (pio_enable(rtl8139->io_addr, RTL8139_IO_SIZE, &rtl8139->io_port)) {
1217 ddf_msg(LVL_ERROR, "Cannot gain the port %p for device %s.", rtl8139->io_addr,
1218 ddf_dev_get_name(dev));
1219 return EADDRNOTAVAIL;
1220 }
1221
1222 return EOK;
1223}
1224
1225/** Initialize the driver private data according to the
1226 * device registers
1227 *
1228 * @param rtl8139 rtl8139 private data
1229 */
1230static void rtl8139_data_init(rtl8139_t *rtl8139)
1231{
1232 assert(rtl8139);
1233
1234 /* Check the version id */
1235 uint32_t tcr = pio_read_32(rtl8139->io_port + TCR);
1236 uint32_t hwverid = RTL8139_HWVERID(tcr);
1237 size_t i = 0;
1238 rtl8139->hw_version = RTL8139_VER_COUNT;
1239 for (i = 0; i < RTL8139_VER_COUNT; ++i) {
1240 if (rtl8139_versions[i].hwverid == 0)
1241 break;
1242
1243 if (rtl8139_versions[i].hwverid == hwverid) {
1244 rtl8139->hw_version = rtl8139_versions[i].ver_id;
1245 ddf_msg(LVL_NOTE, "HW version found: index %zu, ver_id %d (%s)", i,
1246 rtl8139_versions[i].ver_id, model_names[rtl8139->hw_version]);
1247 }
1248 }
1249}
1250
1251/** The add_device callback of RTL8139 callback
1252 *
1253 * Probe and initialize the newly added device.
1254 *
1255 * @param dev The RTL8139 device.
1256 *
1257 * @return EOK if added successfully, error code otherwise
1258 */
1259errno_t rtl8139_dev_add(ddf_dev_t *dev)
1260{
1261 ddf_fun_t *fun;
1262
1263 ddf_msg(LVL_NOTE, "RTL8139_dev_add %s (handle = %zu)",
1264 ddf_dev_get_name(dev), ddf_dev_get_handle(dev));
1265
1266 /* Init device structure for rtl8139 */
1267 errno_t rc = rtl8139_device_initialize(dev);
1268 if (rc != EOK)
1269 return rc;
1270
1271 /* Map I/O ports */
1272 rc = rtl8139_pio_enable(dev);
1273 if (rc != EOK)
1274 goto err_destroy;
1275
1276 nic_t *nic_data = nic_get_from_ddf_dev(dev);
1277 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
1278
1279 nic_address_t addr;
1280 rtl8139_hw_get_addr(rtl8139, &addr);
1281 rc = nic_report_address(nic_data, &addr);
1282 if (rc != EOK)
1283 goto err_pio;
1284
1285 /* Initialize the driver private structure */
1286 rtl8139_data_init(rtl8139);
1287
1288 /* Register interrupt handler */
1289 cap_irq_handle_t irq_handle;
1290 rc = rtl8139_register_int_handler(nic_data, &irq_handle);
1291 if (rc != EOK) {
1292 goto err_pio;
1293 }
1294
1295 fun = ddf_fun_create(nic_get_ddf_dev(nic_data), fun_exposed, "port0");
1296 if (fun == NULL) {
1297 ddf_msg(LVL_ERROR, "Failed creating device function");
1298 goto err_srv;
1299 }
1300
1301 nic_set_ddf_fun(nic_data, fun);
1302 ddf_fun_set_ops(fun, &rtl8139_dev_ops);
1303
1304 rc = ddf_fun_bind(fun);
1305 if (rc != EOK) {
1306 ddf_msg(LVL_ERROR, "Failed binding device function");
1307 goto err_fun_create;
1308 }
1309 rc = ddf_fun_add_to_category(fun, DEVICE_CATEGORY_NIC);
1310 if (rc != EOK) {
1311 ddf_msg(LVL_ERROR, "Failed adding function to category");
1312 goto err_fun_bind;
1313 }
1314
1315 ddf_msg(LVL_NOTE, "The %s device has been successfully initialized.",
1316 ddf_dev_get_name(dev));
1317
1318 return EOK;
1319
1320err_fun_bind:
1321 ddf_fun_unbind(fun);
1322err_fun_create:
1323 ddf_fun_destroy(fun);
1324err_srv:
1325 unregister_interrupt_handler(dev, irq_handle);
1326err_pio:
1327 // rtl8139_pio_disable(dev);
1328 /* TODO: find out if the pio_disable is needed */
1329err_destroy:
1330 rtl8139_dev_cleanup(dev);
1331 return rc;
1332}
1333
1334/** Set card MAC address
1335 *
1336 * @param device The RTL8139 device
1337 * @param address The place to store the address
1338 * @param max_len Maximal addresss length to store
1339 *
1340 * @return EOK if succeed, error code otherwise
1341 */
1342static errno_t rtl8139_set_addr(ddf_fun_t *fun, const nic_address_t *addr)
1343{
1344 assert(fun);
1345 assert(addr);
1346
1347 nic_t *nic_data = nic_get_from_ddf_fun((fun));
1348 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
1349 assert(rtl8139);
1350
1351 rtl8139_lock_all(rtl8139);
1352
1353 errno_t rc = nic_report_address(nic_data, addr);
1354 if (rc != EOK) {
1355 rtl8139_unlock_all(rtl8139);
1356 return rc;
1357 }
1358
1359 rtl8139_hw_set_addr(rtl8139, addr);
1360
1361 rtl8139_unlock_all(rtl8139);
1362 return EOK;
1363}
1364
1365/** Get the device information
1366 *
1367 * @param dev The NIC device
1368 * @param info The information to fill
1369 *
1370 * @return EOK
1371 */
1372static errno_t rtl8139_get_device_info(ddf_fun_t *fun, nic_device_info_t *info)
1373{
1374 assert(fun);
1375 assert(info);
1376
1377 nic_t *nic_data = nic_get_from_ddf_fun(fun);
1378 assert(nic_data);
1379 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
1380 assert(rtl8139);
1381
1382 /* TODO: fill the information more completely */
1383 info->vendor_id = 0x10ec;
1384 str_cpy(info->vendor_name, NIC_VENDOR_MAX_LENGTH, "Realtek");
1385
1386 if (rtl8139->hw_version < RTL8139_VER_COUNT) {
1387 str_cpy(info->model_name, NIC_MODEL_MAX_LENGTH,
1388 model_names[rtl8139->hw_version]);
1389 } else {
1390 str_cpy(info->model_name, NIC_MODEL_MAX_LENGTH, "RTL8139");
1391 }
1392
1393 info->ethernet_support[ETH_10M] = ETH_10BASE_T;
1394 info->ethernet_support[ETH_100M] = ETH_100BASE_TX;
1395
1396 info->autoneg_support = RTL8139_AUTONEG_CAPS;
1397 return EOK;
1398}
1399
1400/** Check the cable state
1401 *
1402 * @param[in] dev The device
1403 * @param[out] state The state to fill
1404 *
1405 * @return EOK
1406 */
1407static errno_t rtl8139_get_cable_state(ddf_fun_t *fun, nic_cable_state_t *state)
1408{
1409 assert(fun);
1410 assert(state);
1411
1412 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1413 assert(rtl8139);
1414
1415 if (pio_read_16(rtl8139->io_port + CSCR) & CS_CON_STATUS) {
1416 *state = NIC_CS_PLUGGED;
1417 } else {
1418 *state = NIC_CS_UNPLUGGED;
1419 }
1420
1421 return EOK;
1422}
1423
1424/** Get operation mode of the device
1425 */
1426static errno_t rtl8139_get_operation_mode(ddf_fun_t *fun, int *speed,
1427 nic_channel_mode_t *duplex, nic_role_t *role)
1428{
1429 assert(fun);
1430 assert(speed);
1431 assert(duplex);
1432 assert(role);
1433
1434 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1435 assert(rtl8139);
1436
1437 uint16_t bmcr_val = pio_read_16(rtl8139->io_port + BMCR);
1438 uint8_t msr_val = pio_read_8(rtl8139->io_port + MSR);
1439
1440 if (bmcr_val & BMCR_DUPLEX) {
1441 *duplex = NIC_CM_FULL_DUPLEX;
1442 } else {
1443 *duplex = NIC_CM_HALF_DUPLEX;
1444 }
1445
1446 if (msr_val & MSR_SPEED10) {
1447 *speed = 10;
1448 } else {
1449 *speed = 100;
1450 }
1451
1452 *role = NIC_ROLE_UNKNOWN;
1453 return EOK;
1454}
1455
1456/** Value validity */
1457enum access_mode {
1458 /** Value is invalid now */
1459 VALUE_INVALID = 0,
1460 /** Read-only */
1461 VALUE_RO,
1462 /** Read-write */
1463 VALUE_RW
1464};
1465
1466/** Check if pause frame operations are valid in current situation
1467 *
1468 * @param rtl8139 RTL8139 private structure
1469 *
1470 * @return VALUE_INVALID if the value has no sense in current moment
1471 * @return VALUE_RO if the state is read-only in current moment
1472 * @return VALUE_RW if the state can be modified
1473 */
1474static int rtl8139_pause_is_valid(rtl8139_t *rtl8139)
1475{
1476 assert(rtl8139);
1477
1478 uint16_t bmcr = pio_read_16(rtl8139->io_port + BMCR);
1479 if ((bmcr & (BMCR_AN_ENABLE | BMCR_DUPLEX)) == 0)
1480 return VALUE_INVALID;
1481
1482 if (bmcr & BMCR_AN_ENABLE) {
1483 uint16_t anar_lp = pio_read_16(rtl8139->io_port + ANLPAR);
1484 if (anar_lp & ANAR_PAUSE)
1485 return VALUE_RO;
1486 }
1487
1488 return VALUE_RW;
1489}
1490
1491/** Get current pause frame configuration
1492 *
1493 * Values are filled with NIC_RESULT_NOT_AVAILABLE if the value has no sense in
1494 * the moment (half-duplex).
1495 *
1496 * @param[in] fun The DDF structure of the RTL8139
1497 * @param[out] we_send Sign if local constroller sends pause frame
1498 * @param[out] we_receive Sign if local constroller receives pause frame
1499 * @param[out] time Time filled in pause frames. 0xFFFF in rtl8139
1500 *
1501 * @return EOK if succeed
1502 */
1503static errno_t rtl8139_pause_get(ddf_fun_t *fun, nic_result_t *we_send,
1504 nic_result_t *we_receive, uint16_t *time)
1505{
1506 assert(fun);
1507 assert(we_send);
1508 assert(we_receive);
1509
1510 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1511 assert(rtl8139);
1512
1513 if (rtl8139_pause_is_valid(rtl8139) == VALUE_INVALID) {
1514 *we_send = NIC_RESULT_NOT_AVAILABLE;
1515 *we_receive = NIC_RESULT_NOT_AVAILABLE;
1516 *time = 0;
1517 return EOK;
1518 }
1519
1520 uint8_t msr = pio_read_8(rtl8139->io_port + MSR);
1521
1522 *we_send = (msr & MSR_TXFCE) ? NIC_RESULT_ENABLED : NIC_RESULT_DISABLED;
1523 *we_receive = (msr & MSR_RXFCE) ? NIC_RESULT_ENABLED : NIC_RESULT_DISABLED;
1524 *time = RTL8139_PAUSE_VAL;
1525
1526 return EOK;
1527}
1528
1529/** Set current pause frame configuration
1530 *
1531 * @param fun The DDF structure of the RTL8139
1532 * @param allow_send Sign if local constroller sends pause frame
1533 * @param allow_receive Sign if local constroller receives pause frames
1534 * @param time Time to use, ignored (not supported by device)
1535 *
1536 * @return EOK if succeed, INVAL if the pause frame has no sence
1537 */
1538static errno_t rtl8139_pause_set(ddf_fun_t *fun, int allow_send, int allow_receive,
1539 uint16_t time)
1540{
1541 assert(fun);
1542
1543 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1544 assert(rtl8139);
1545
1546 if (rtl8139_pause_is_valid(rtl8139) != VALUE_RW)
1547 return EINVAL;
1548
1549 uint8_t msr = pio_read_8(rtl8139->io_port + MSR);
1550 msr &= ~(uint8_t)(MSR_TXFCE | MSR_RXFCE);
1551
1552 if (allow_receive)
1553 msr |= MSR_RXFCE;
1554 if (allow_send)
1555 msr |= MSR_TXFCE;
1556
1557 pio_write_8(rtl8139->io_port + MSR, msr);
1558
1559 if (allow_send && time > 0) {
1560 ddf_msg(LVL_WARN, "Time setting is not supported in set_pause method.");
1561 }
1562 return EOK;
1563}
1564
1565/** Set operation mode of the device
1566 *
1567 */
1568static errno_t rtl8139_set_operation_mode(ddf_fun_t *fun, int speed,
1569 nic_channel_mode_t duplex, nic_role_t role)
1570{
1571 assert(fun);
1572
1573 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1574 assert(rtl8139);
1575
1576 if (speed != 10 && speed != 100)
1577 return EINVAL;
1578 if (duplex != NIC_CM_HALF_DUPLEX && duplex != NIC_CM_FULL_DUPLEX)
1579 return EINVAL;
1580
1581 uint16_t bmcr_val = pio_read_16(rtl8139->io_port + BMCR);
1582
1583 /* Set autonegotion disabled */
1584 bmcr_val &= ~(uint16_t)BMCR_AN_ENABLE;
1585
1586 if (duplex == NIC_CM_FULL_DUPLEX) {
1587 bmcr_val |= BMCR_DUPLEX;
1588 } else {
1589 bmcr_val &= ~((uint16_t)BMCR_DUPLEX);
1590 }
1591
1592 if (speed == 100) {
1593 bmcr_val |= BMCR_Spd_100;
1594 } else {
1595 bmcr_val &= ~((uint16_t)BMCR_Spd_100);
1596 }
1597
1598 rtl8139_regs_unlock(rtl8139->io_port);
1599 pio_write_16(rtl8139->io_port + BMCR, bmcr_val);
1600 rtl8139_regs_lock(rtl8139->io_port);
1601 return EOK;
1602}
1603
1604/** Enable autonegoation with specific advertisement
1605 *
1606 * @param dev The device to update
1607 * @param advertisement The advertisement to set
1608 *
1609 * @returns EINVAL if the advertisement mode is not supproted
1610 * @returns EOK if advertisement mode set successfully
1611 */
1612static errno_t rtl8139_autoneg_enable(ddf_fun_t *fun, uint32_t advertisement)
1613{
1614 assert(fun);
1615
1616 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1617 assert(rtl8139);
1618
1619 if (advertisement == 0) {
1620 advertisement = RTL8139_AUTONEG_CAPS;
1621 }
1622
1623 if ((advertisement | RTL8139_AUTONEG_CAPS) != RTL8139_AUTONEG_CAPS)
1624 return EINVAL; /* some unsuported mode is requested */
1625
1626 assert(advertisement != 0);
1627
1628 /* Set the autonegotiation advertisement */
1629 uint16_t anar = ANAR_SELECTOR; /* default selector */
1630 if (advertisement & ETH_AUTONEG_10BASE_T_FULL)
1631 anar |= ANAR_10_FD;
1632 if (advertisement & ETH_AUTONEG_10BASE_T_HALF)
1633 anar |= ANAR_10_HD;
1634 if (advertisement & ETH_AUTONEG_100BASE_TX_FULL)
1635 anar |= ANAR_100TX_FD;
1636 if (advertisement & ETH_AUTONEG_100BASE_TX_HALF)
1637 anar |= ANAR_100TX_HD;
1638 if (advertisement & ETH_AUTONEG_PAUSE_SYMETRIC)
1639 anar |= ANAR_PAUSE;
1640
1641 uint16_t bmcr_val = pio_read_16(rtl8139->io_port + BMCR);
1642 bmcr_val |= BMCR_AN_ENABLE;
1643
1644 pio_write_16(rtl8139->io_port + ANAR, anar);
1645
1646 rtl8139_regs_unlock(rtl8139->io_port);
1647 pio_write_16(rtl8139->io_port + BMCR, bmcr_val);
1648 rtl8139_regs_lock(rtl8139->io_port);
1649 return EOK;
1650}
1651
1652/** Disable advertisement functionality
1653 *
1654 * @param dev The device to update
1655 *
1656 * @returns EOK
1657 */
1658static errno_t rtl8139_autoneg_disable(ddf_fun_t *fun)
1659{
1660 assert(fun);
1661
1662 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1663 assert(rtl8139);
1664
1665 uint16_t bmcr_val = pio_read_16(rtl8139->io_port + BMCR);
1666
1667 bmcr_val &= ~((uint16_t)BMCR_AN_ENABLE);
1668
1669 rtl8139_regs_unlock(rtl8139->io_port);
1670 pio_write_16(rtl8139->io_port + BMCR, bmcr_val);
1671 rtl8139_regs_lock(rtl8139->io_port);
1672
1673 return EOK;
1674}
1675
1676/** Obtain the advertisement NIC framework value from the ANAR/ANLPAR register
1677 * value
1678 *
1679 * @param[in] anar The ANAR register value
1680 * @param[out] advertisement The advertisement result
1681 */
1682static void rtl8139_get_anar_state(uint16_t anar, uint32_t *advertisement)
1683{
1684 *advertisement = 0;
1685 if (anar & ANAR_10_HD)
1686 *advertisement |= ETH_AUTONEG_10BASE_T_HALF;
1687 if (anar & ANAR_10_FD)
1688 *advertisement |= ETH_AUTONEG_10BASE_T_FULL;
1689 if (anar & ANAR_100TX_HD)
1690 *advertisement |= ETH_AUTONEG_100BASE_TX_HALF;
1691 if (anar & ANAR_100TX_FD)
1692 *advertisement |= ETH_AUTONEG_100BASE_TX_FULL;
1693 if (anar & ANAR_100T4)
1694 *advertisement |= ETH_AUTONEG_100BASE_T4_HALF;
1695 if (anar & ANAR_PAUSE)
1696 *advertisement |= ETH_AUTONEG_PAUSE_SYMETRIC;
1697}
1698
1699/** Check the autonegotion state
1700 *
1701 * @param[in] dev The device to check
1702 * @param[out] advertisement The device advertisement
1703 * @param[out] their_adv The partners advertisement
1704 * @param[out] result The autonegotion state
1705 * @param[out] their_result The link partner autonegotion status
1706 *
1707 * @returns EOK
1708 */
1709static errno_t rtl8139_autoneg_probe(ddf_fun_t *fun, uint32_t *advertisement,
1710 uint32_t *their_adv, nic_result_t *result, nic_result_t *their_result)
1711{
1712 assert(fun);
1713
1714 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1715 assert(rtl8139);
1716
1717 uint16_t bmcr = pio_read_16(rtl8139->io_port + BMCR);
1718 uint16_t anar = pio_read_16(rtl8139->io_port + ANAR);
1719 uint16_t anar_lp = pio_read_16(rtl8139->io_port + ANLPAR);
1720 uint16_t aner = pio_read_16(rtl8139->io_port + ANER);
1721
1722 if (bmcr & BMCR_AN_ENABLE) {
1723 *result = NIC_RESULT_ENABLED;
1724 } else {
1725 *result = NIC_RESULT_DISABLED;
1726 }
1727
1728 if (aner & ANER_LP_NW_ABLE) {
1729 *their_result = NIC_RESULT_ENABLED;
1730 } else {
1731 *their_result = NIC_RESULT_DISABLED;
1732 }
1733
1734 rtl8139_get_anar_state(anar, advertisement);
1735 rtl8139_get_anar_state(anar_lp, their_adv);
1736
1737 return EOK;
1738}
1739
1740/** Restart autonegotiation process
1741 *
1742 * @param dev The device to update
1743 *
1744 * @returns EOK
1745 */
1746static errno_t rtl8139_autoneg_restart(ddf_fun_t *fun)
1747{
1748 assert(fun);
1749
1750 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1751 assert(rtl8139);
1752
1753 uint16_t bmcr = pio_read_16(rtl8139->io_port + BMCR);
1754 bmcr |= BMCR_AN_RESTART;
1755 bmcr |= BMCR_AN_ENABLE;
1756
1757 rtl8139_regs_unlock(rtl8139);
1758 pio_write_16(rtl8139->io_port + BMCR, bmcr);
1759 rtl8139_regs_lock(rtl8139);
1760
1761 return EOK;
1762}
1763
1764/** Notify NIC framework about HW filtering state when promisc mode was disabled
1765 *
1766 * @param nic_data The NIC data
1767 * @param mcast_mode Current multicast mode
1768 * @param was_promisc Sign if the promiscuous mode was active before disabling
1769 */
1770inline static void rtl8139_rcx_promics_rem(nic_t *nic_data,
1771 nic_multicast_mode_t mcast_mode, uint8_t was_promisc)
1772{
1773 assert(nic_data);
1774
1775 if (was_promisc != 0) {
1776 if (mcast_mode == NIC_MULTICAST_LIST)
1777 nic_report_hw_filtering(nic_data, 1, 0, -1);
1778 else
1779 nic_report_hw_filtering(nic_data, 1, 1, -1);
1780 } else {
1781 nic_report_hw_filtering(nic_data, 1, -1, -1);
1782 }
1783}
1784
1785/** Set unicast frames acceptance mode
1786 *
1787 * @param nic_data The nic device to update
1788 * @param mode The mode to set
1789 * @param addr Ignored, no HW support, just use unicast promisc
1790 * @param addr_cnt Ignored, no HW support
1791 *
1792 * @returns EOK
1793 */
1794static errno_t rtl8139_unicast_set(nic_t *nic_data, nic_unicast_mode_t mode,
1795 const nic_address_t *addr, size_t addr_cnt)
1796{
1797 assert(nic_data);
1798
1799 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
1800 assert(rtl8139);
1801
1802 uint8_t was_promisc = rtl8139->rcr_data.ucast_mask & RCR_ACCEPT_ALL_PHYS;
1803
1804 nic_multicast_mode_t mcast_mode;
1805 nic_query_multicast(nic_data, &mcast_mode, 0, NULL, NULL);
1806
1807 switch (mode) {
1808 case NIC_UNICAST_BLOCKED:
1809 rtl8139->rcr_data.ucast_mask = 0;
1810 rtl8139_rcx_promics_rem(nic_data, mcast_mode, was_promisc);
1811 break;
1812 case NIC_UNICAST_DEFAULT:
1813 rtl8139->rcr_data.ucast_mask = RCR_ACCEPT_PHYS_MATCH;
1814 rtl8139_rcx_promics_rem(nic_data, mcast_mode, was_promisc);
1815 break;
1816 case NIC_UNICAST_LIST:
1817 rtl8139->rcr_data.ucast_mask = RCR_ACCEPT_PHYS_MATCH |
1818 RCR_ACCEPT_ALL_PHYS;
1819
1820 if (mcast_mode == NIC_MULTICAST_PROMISC)
1821 nic_report_hw_filtering(nic_data, 0, 1, -1);
1822 else
1823 nic_report_hw_filtering(nic_data, 0, 0, -1);
1824 break;
1825 case NIC_UNICAST_PROMISC:
1826 rtl8139->rcr_data.ucast_mask = RCR_ACCEPT_PHYS_MATCH |
1827 RCR_ACCEPT_ALL_PHYS;
1828
1829 if (mcast_mode == NIC_MULTICAST_PROMISC)
1830 nic_report_hw_filtering(nic_data, 1, 1, -1);
1831 else
1832 nic_report_hw_filtering(nic_data, 1, 0, -1);
1833 break;
1834 default:
1835 return ENOTSUP;
1836 }
1837 fibril_mutex_lock(&rtl8139->rx_lock);
1838 rtl8139_hw_update_rcr(rtl8139);
1839 fibril_mutex_unlock(&rtl8139->rx_lock);
1840 return EOK;
1841}
1842
1843/** Set multicast frames acceptance mode
1844 *
1845 * @param nic_data The nic device to update
1846 * @param mode The mode to set
1847 * @param addr Addresses to accept
1848 * @param addr_cnt Addresses count
1849 *
1850 * @returns EOK
1851 */
1852static errno_t rtl8139_multicast_set(nic_t *nic_data, nic_multicast_mode_t mode,
1853 const nic_address_t *addr, size_t addr_count)
1854{
1855 assert(nic_data);
1856 assert(addr_count == 0 || addr);
1857
1858 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
1859 assert(rtl8139);
1860
1861 switch (mode) {
1862 case NIC_MULTICAST_BLOCKED:
1863 rtl8139->rcr_data.mcast_mask = 0;
1864 if ((rtl8139->rcr_data.ucast_mask & RCR_ACCEPT_ALL_PHYS) != 0)
1865 nic_report_hw_filtering(nic_data, -1, 0, -1);
1866 else
1867 nic_report_hw_filtering(nic_data, -1, 1, -1);
1868 break;
1869 case NIC_MULTICAST_LIST:
1870 rtl8139_hw_set_mcast_mask(rtl8139, nic_mcast_hash(addr, addr_count));
1871 rtl8139->rcr_data.mcast_mask = RCR_ACCEPT_MULTICAST;
1872 nic_report_hw_filtering(nic_data, -1, 0, -1);
1873 break;
1874 case NIC_MULTICAST_PROMISC:
1875 rtl8139_hw_set_mcast_mask(rtl8139, RTL8139_MCAST_MASK_PROMISC);
1876 rtl8139->rcr_data.mcast_mask = RCR_ACCEPT_MULTICAST;
1877 nic_report_hw_filtering(nic_data, -1, 1, -1);
1878 break;
1879 default:
1880 return ENOTSUP;
1881 }
1882 fibril_mutex_lock(&rtl8139->rx_lock);
1883 rtl8139_hw_update_rcr(rtl8139);
1884 fibril_mutex_unlock(&rtl8139->rx_lock);
1885 return EOK;
1886}
1887
1888/** Set broadcast frames acceptance mode
1889 *
1890 * @param nic_data The nic device to update
1891 * @param mode The mode to set
1892 *
1893 * @returns EOK
1894 */
1895static errno_t rtl8139_broadcast_set(nic_t *nic_data, nic_broadcast_mode_t mode)
1896{
1897 assert(nic_data);
1898
1899 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
1900 assert(rtl8139);
1901
1902 switch (mode) {
1903 case NIC_BROADCAST_BLOCKED:
1904 rtl8139->rcr_data.bcast_mask = 0;
1905 break;
1906 case NIC_BROADCAST_ACCEPTED:
1907 rtl8139->rcr_data.bcast_mask = RCR_ACCEPT_BROADCAST;
1908 break;
1909 default:
1910 return ENOTSUP;
1911 }
1912 fibril_mutex_lock(&rtl8139->rx_lock);
1913 rtl8139_hw_update_rcr(rtl8139);
1914 fibril_mutex_unlock(&rtl8139->rx_lock);
1915 return EOK;
1916}
1917
1918/** Get state of acceptance of weird frames
1919 *
1920 * @param[in] device The device to check
1921 * @param[out] mode The current mode
1922 */
1923static errno_t rtl8139_defective_get_mode(ddf_fun_t *fun, uint32_t *mode)
1924{
1925 assert(fun);
1926 assert(mode);
1927
1928 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1929 assert(rtl8139);
1930
1931 *mode = 0;
1932 if (rtl8139->rcr_data.defect_mask & RCR_ACCEPT_ERROR)
1933 *mode |= NIC_DEFECTIVE_BAD_CRC;
1934 if (rtl8139->rcr_data.defect_mask & RCR_ACCEPT_RUNT)
1935 *mode |= NIC_DEFECTIVE_SHORT;
1936
1937 return EOK;
1938}
1939
1940/** Set acceptance of weird frames
1941 *
1942 * @param device The device to update
1943 * @param mode The mode to set
1944 *
1945 * @returns ENOTSUP if the mode is not supported
1946 * @returns EOK of mode was set
1947 */
1948static errno_t rtl8139_defective_set_mode(ddf_fun_t *fun, uint32_t mode)
1949{
1950 assert(fun);
1951
1952 rtl8139_t *rtl8139 = nic_get_specific(nic_get_from_ddf_fun(fun));
1953 assert(rtl8139);
1954
1955 if ((mode & (NIC_DEFECTIVE_SHORT | NIC_DEFECTIVE_BAD_CRC)) != mode)
1956 return ENOTSUP;
1957
1958 rtl8139->rcr_data.defect_mask = 0;
1959 if (mode & NIC_DEFECTIVE_SHORT)
1960 rtl8139->rcr_data.defect_mask |= RCR_ACCEPT_RUNT;
1961 if (mode & NIC_DEFECTIVE_BAD_CRC)
1962 rtl8139->rcr_data.defect_mask |= RCR_ACCEPT_ERROR;
1963
1964 fibril_mutex_lock(&rtl8139->rx_lock);
1965 rtl8139_hw_update_rcr(rtl8139);
1966 fibril_mutex_unlock(&rtl8139->rx_lock);
1967 return EOK;
1968}
1969
1970/** Turn Wakeup On Lan method on
1971 *
1972 * @param nic_data The NIC to update
1973 * @param virtue The method to turn on
1974 *
1975 * @returns EINVAL if the method is not supported
1976 * @returns EOK if succeed
1977 * @returns ELIMIT if no more methods of this kind can be enabled
1978 */
1979static errno_t rtl8139_wol_virtue_add(nic_t *nic_data,
1980 const nic_wol_virtue_t *virtue)
1981{
1982 assert(nic_data);
1983 assert(virtue);
1984
1985 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
1986 assert(rtl8139);
1987
1988 switch (virtue->type) {
1989 case NIC_WV_BROADCAST:
1990 rtl8139_hw_reg_add_8(rtl8139, CONFIG5, CONFIG5_BROADCAST_WAKEUP);
1991 break;
1992 case NIC_WV_LINK_CHANGE:
1993 rtl8139_regs_unlock(rtl8139->io_port);
1994 rtl8139_hw_reg_add_8(rtl8139, CONFIG3, CONFIG3_LINK_UP);
1995 rtl8139_regs_lock(rtl8139->io_port);
1996 break;
1997 case NIC_WV_MAGIC_PACKET:
1998 if (virtue->data)
1999 return EINVAL;
2000 rtl8139_regs_unlock(rtl8139->io_port);
2001 rtl8139_hw_reg_add_8(rtl8139, CONFIG3, CONFIG3_MAGIC);
2002 rtl8139_regs_lock(rtl8139->io_port);
2003 break;
2004 default:
2005 return EINVAL;
2006 }
2007 if (rtl8139->pm.active++ == 0)
2008 rtl8139_hw_pmen_set(rtl8139, 1);
2009 return EOK;
2010}
2011
2012/** Turn Wakeup On Lan method off
2013 *
2014 * @param nic_data The NIC to update
2015 * @param virtue The method to turn off
2016 */
2017static void rtl8139_wol_virtue_rem(nic_t *nic_data,
2018 const nic_wol_virtue_t *virtue)
2019{
2020 assert(nic_data);
2021 assert(virtue);
2022
2023 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
2024 assert(rtl8139);
2025
2026 switch (virtue->type) {
2027 case NIC_WV_BROADCAST:
2028 rtl8139_hw_reg_rem_8(rtl8139, CONFIG5, CONFIG5_BROADCAST_WAKEUP);
2029 break;
2030 case NIC_WV_LINK_CHANGE:
2031 rtl8139_regs_unlock(rtl8139->io_port);
2032 rtl8139_hw_reg_rem_8(rtl8139, CONFIG3, CONFIG3_LINK_UP);
2033 rtl8139_regs_lock(rtl8139->io_port);
2034 break;
2035 case NIC_WV_MAGIC_PACKET:
2036 rtl8139_regs_unlock(rtl8139->io_port);
2037 rtl8139_hw_reg_rem_8(rtl8139, CONFIG3, CONFIG3_MAGIC);
2038 rtl8139_regs_lock(rtl8139->io_port);
2039 break;
2040 default:
2041 return;
2042 }
2043 rtl8139->pm.active--;
2044 if (rtl8139->pm.active == 0)
2045 rtl8139_hw_pmen_set(rtl8139, 0);
2046}
2047
2048/** Set polling mode
2049 *
2050 * @param device The device to set
2051 * @param mode The mode to set
2052 * @param period The period for NIC_POLL_PERIODIC
2053 *
2054 * @returns EOK if succeed
2055 * @returns ENOTSUP if the mode is not supported
2056 */
2057static errno_t rtl8139_poll_mode_change(nic_t *nic_data, nic_poll_mode_t mode,
2058 const struct timespec *period)
2059{
2060 assert(nic_data);
2061 errno_t rc = EOK;
2062
2063 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
2064 assert(rtl8139);
2065
2066 fibril_mutex_lock(&rtl8139->rx_lock);
2067
2068 switch (mode) {
2069 case NIC_POLL_IMMEDIATE:
2070 rtl8139->int_mask = RTL_DEFAULT_INTERRUPTS;
2071 break;
2072 case NIC_POLL_ON_DEMAND:
2073 rtl8139->int_mask = 0;
2074 break;
2075 case NIC_POLL_PERIODIC:
2076 assert(period);
2077
2078 rtl8139_timer_act_t new_timer;
2079 rc = rtl8139_timer_act_init(&new_timer, RTL8139_PCI_FREQ_KHZ, period);
2080 if (rc != EOK)
2081 break;
2082
2083 /* Disable timer interrupts while working with timer-related data */
2084 rtl8139->int_mask = 0;
2085 rtl8139_hw_int_set(rtl8139);
2086
2087 rtl8139->poll_timer = new_timer;
2088 rtl8139->int_mask = INT_TIME_OUT;
2089
2090 /*
2091 * Force timer interrupt start be writing nonzero value to timer
2092 * interrutp register (should be small to prevent big delay)
2093 * Read TCTR to reset timer counter
2094 * Change values to simulate the last interrupt from the period.
2095 */
2096 pio_write_32(rtl8139->io_port + TIMERINT, 10);
2097 pio_write_32(rtl8139->io_port + TCTR, 0);
2098
2099 ddf_msg(LVL_DEBUG, "Periodic mode. Interrupt mask %" PRIx16 ", "
2100 "poll.full_skips %zu, last timer %" PRIu32,
2101 rtl8139->int_mask, rtl8139->poll_timer.full_skips,
2102 rtl8139->poll_timer.last_val);
2103 break;
2104 default:
2105 rc = ENOTSUP;
2106 break;
2107 }
2108
2109 rtl8139_hw_int_set(rtl8139);
2110
2111 fibril_mutex_unlock(&rtl8139->rx_lock);
2112
2113 return rc;
2114}
2115
2116/** Force receiving all frames in the receive buffer
2117 *
2118 * @param device The device to receive
2119 */
2120static void rtl8139_poll(nic_t *nic_data)
2121{
2122 assert(nic_data);
2123
2124 rtl8139_t *rtl8139 = nic_get_specific(nic_data);
2125 assert(rtl8139);
2126
2127 uint16_t isr = pio_read_16(rtl8139->io_port + ISR);
2128 pio_write_16(rtl8139->io_port + ISR, 0);
2129
2130 rtl8139_interrupt_impl(nic_data, isr);
2131}
2132
2133/** Main function of RTL8139 driver
2134 *
2135 * Just initialize the driver structures and
2136 * put it into the device drivers interface
2137 */
2138int main(void)
2139{
2140 printf("%s: HelenOS RTL8139 network adapter driver\n", NAME);
2141
2142 errno_t rc = nic_driver_init(NAME);
2143 if (rc != EOK)
2144 return rc;
2145
2146 nic_driver_implement(&rtl8139_driver_ops, &rtl8139_dev_ops,
2147 &rtl8139_nic_iface);
2148
2149 ddf_log_init(NAME);
2150 return ddf_driver_main(&rtl8139_driver);
2151}
Note: See TracBrowser for help on using the repository browser.