source: mainline/uspace/lib/nic/include/nic.h@ 79b5bc9

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 79b5bc9 was a5c82bb9, checked in by Jiri Svoboda <jiri@…>, 14 years ago

NIC no longer needs to support non-Ethernet frames.
  • Property mode set to 100644
File size: 9.9 KB
Line 
1/*
2 * Copyright (c) 2011 Radim Vansa
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/**
30 * @addtogroup libnic
31 * @{
32 */
33/**
34 * @file
35 * @brief Public header exposing NICF to drivers
36 */
37
38#ifndef __NIC_H__
39#define __NIC_H__
40
41#include <adt/list.h>
42#include <ddf/driver.h>
43#include <device/hw_res_parsed.h>
44#include <ops/nic.h>
45
46#define DEVICE_CATEGORY_NIC "nic"
47
48struct nic;
49typedef struct nic nic_t;
50
51/**
52 * Single WOL virtue descriptor.
53 */
54typedef struct nic_wol_virtue {
55 link_t item;
56 nic_wv_id_t id;
57 nic_wv_type_t type;
58 const void *data;
59 size_t length;
60 struct nic_wol_virtue *next;
61} nic_wol_virtue_t;
62
63/**
64 * Simple structure for sending lists of frames.
65 */
66typedef struct {
67 link_t link;
68 void *data;
69 size_t size;
70} nic_frame_t;
71
72typedef list_t nic_frame_list_t;
73
74/**
75 * Handler for writing frame data to the NIC device.
76 * The function is responsible for releasing the frame.
77 * It does not return anything, if some error is detected the function just
78 * silently fails (logging on debug level is suggested).
79 *
80 * @param nic_data
81 * @param data Pointer to frame data
82 * @param size Size of frame data in bytes
83 */
84typedef void (*send_frame_handler)(nic_t *, void *, size_t);
85/**
86 * The handler for transitions between driver states.
87 * If the handler returns negative error code, the transition between
88 * states is canceled (the state is not changed).
89 *
90 * @param nic_data NICF main structure
91 *
92 * @return EOK If everything is all right.
93 * @return negative error code on error.
94 */
95typedef int (*state_change_handler)(nic_t *);
96/**
97 * Handler for unicast filtering mode change.
98 *
99 * @param nic_data NICF main structure
100 * @param new_mode The mode that should be set up
101 * @param address_list Addresses as argument to the mode
102 * @param address_count Number of addresses in the list
103 *
104 * @return EOK If the mode is set up
105 * @return ENOTSUP If this mode is not supported
106 */
107typedef int (*unicast_mode_change_handler)(nic_t *,
108 nic_unicast_mode_t, const nic_address_t *, size_t);
109/**
110 * Handler for multicast filtering mode change.
111 *
112 * @param nic_data NICF main structure
113 * @param new_mode The mode that should be set up
114 * @param address_list Addresses as argument to the mode
115 * @param address_count Number of addresses in the list
116 *
117 * @return EOK If the mode is set up
118 * @return ENOTSUP If this mode is not supported
119 */
120typedef int (*multicast_mode_change_handler)(nic_t *,
121 nic_multicast_mode_t, const nic_address_t *, size_t);
122/**
123 * Handler for broadcast filtering mode change.
124 *
125 * @param nic_data NICF main structure
126 * @param new_mode The mode that should be set up
127 *
128 * @return EOK If the mode is set up
129 * @return ENOTSUP If this mode is not supported
130 */
131typedef int (*broadcast_mode_change_handler)(nic_t *, nic_broadcast_mode_t);
132/**
133 * Handler for blocked sources list change.
134 *
135 * @param nic_data NICF main structure
136 * @param address_list Addresses as argument to the mode
137 * @param address_count Number of addresses in the list
138 */
139typedef void (*blocked_sources_change_handler)(nic_t *,
140 const nic_address_t *, size_t);
141/**
142 * Handler for VLAN filtering mask change.
143 * @param nic_data NICF main structure
144 * @param vlan_mask The new mask | NULL for disabling vlan filter
145 */
146typedef void (*vlan_mask_change_handler)(nic_t *, const nic_vlan_mask_t *);
147/**
148 * Handler called when a WOL virtue is added.
149 * If the maximum of accepted WOL virtues changes due to adding this virtue
150 * you should update the vector wol_virtues.caps_max.
151 * The driver is allowed to store pointer to the virtue data until
152 * on_wol_virtue_remove on these data is called (although probably this is
153 * not a good practice).
154 *
155 * @param nic_data NICF main structure
156 * @param virtue Structure with virtue description
157 *
158 * @return EOK If the filter can be used. Software emulation of the
159 * filter is activated unless the emulate is set to 0.
160 * @return ENOTSUP If this filter cannot work on this NIC (e.g. the NIC
161 * cannot run in promiscuous node or the limit of WOL
162 * frames' specifications was reached).
163 * @return ELIMIT If this filter must implemented in HW but currently the
164 * limit of these HW filters was reached.
165 */
166typedef int (*wol_virtue_add_handler)(nic_t *, const nic_wol_virtue_t *);
167/**
168 * Handler called when a WOL virtue is removed.
169 * If the maximum of accepted WOL virtues changes due to removing this
170 * virtue you should update the vector wol_virtues.caps_max.
171 *
172 * @param nic_data NICF main structure
173 * @param virtue Structure with virtue description
174 */
175typedef void (*wol_virtue_remove_handler)(nic_t *, const nic_wol_virtue_t *);
176/**
177 * Handler for poll mode change.
178 *
179 * @param nic_data NICF main structure
180 * @param mode Mode to be set up
181 * @param period New period of polling (with NIC_POLL_PERIODIC)
182 *
183 * @return EOK If the mode was fully setup
184 * @return ENOTSUP If NICF should do the periodic polling
185 * @return EINVAL If this mode cannot be set up under no circumstances
186 */
187typedef int (*poll_mode_change_handler)(nic_t *,
188 nic_poll_mode_t, const struct timeval *);
189/**
190 * Event handler called when the NIC should poll its buffers for a new frame
191 * (in NIC_POLL_PERIODIC or NIC_POLL_ON_DEMAND) modes.
192 *
193 * @param nic_data NICF main structure
194 */
195typedef void (*poll_request_handler)(nic_t *);
196
197/* nic_t allocation and deallocation */
198extern nic_t *nic_create_and_bind(ddf_dev_t *);
199extern void nic_unbind_and_destroy(ddf_dev_t *);
200
201/* Functions called in the main function */
202extern int nic_driver_init(const char *);
203extern void nic_driver_implement(driver_ops_t *, ddf_dev_ops_t *,
204 nic_iface_t *);
205
206/* Functions called in add_device */
207extern int nic_connect_to_services(nic_t *);
208extern int nic_get_resources(nic_t *, hw_res_list_parsed_t *);
209extern void nic_set_specific(nic_t *, void *);
210extern void nic_set_send_frame_handler(nic_t *, send_frame_handler);
211extern void nic_set_state_change_handlers(nic_t *,
212 state_change_handler, state_change_handler, state_change_handler);
213extern void nic_set_filtering_change_handlers(nic_t *,
214 unicast_mode_change_handler, multicast_mode_change_handler,
215 broadcast_mode_change_handler, blocked_sources_change_handler,
216 vlan_mask_change_handler);
217extern void nic_set_wol_virtue_change_handlers(nic_t *,
218 wol_virtue_add_handler, wol_virtue_remove_handler);
219extern void nic_set_poll_handlers(nic_t *,
220 poll_mode_change_handler, poll_request_handler);
221
222/* General driver functions */
223extern ddf_dev_t *nic_get_ddf_dev(nic_t *);
224extern ddf_fun_t *nic_get_ddf_fun(nic_t *);
225extern void nic_set_ddf_fun(nic_t *, ddf_fun_t *);
226extern nic_t *nic_get_from_ddf_dev(ddf_dev_t *);
227extern nic_t *nic_get_from_ddf_fun(ddf_fun_t *);
228extern void *nic_get_specific(nic_t *);
229extern nic_device_state_t nic_query_state(nic_t *);
230extern void nic_set_tx_busy(nic_t *, int);
231extern int nic_report_address(nic_t *, const nic_address_t *);
232extern int nic_report_poll_mode(nic_t *, nic_poll_mode_t, struct timeval *);
233extern void nic_query_address(nic_t *, nic_address_t *);
234extern void nic_received_frame(nic_t *, nic_frame_t *);
235extern void nic_received_frame_list(nic_t *, nic_frame_list_t *);
236extern void nic_disable_interrupt(nic_t *, int);
237extern void nic_enable_interrupt(nic_t *, int);
238extern nic_poll_mode_t nic_query_poll_mode(nic_t *, struct timeval *);
239
240/* Statistics updates */
241extern void nic_report_send_ok(nic_t *, size_t, size_t);
242extern void nic_report_send_error(nic_t *, nic_send_error_cause_t, unsigned);
243extern void nic_report_receive_error(nic_t *, nic_receive_error_cause_t,
244 unsigned);
245extern void nic_report_collisions(nic_t *, unsigned);
246
247/* Frame / frame list allocation and deallocation */
248extern nic_frame_t *nic_alloc_frame(nic_t *, size_t);
249extern nic_frame_list_t *nic_alloc_frame_list(void);
250extern void nic_frame_list_append(nic_frame_list_t *, nic_frame_t *);
251extern void nic_release_frame(nic_t *, nic_frame_t *);
252
253/* RXC query and report functions */
254extern void nic_report_hw_filtering(nic_t *, int, int, int);
255extern void nic_query_unicast(const nic_t *,
256 nic_unicast_mode_t *, size_t, nic_address_t *, size_t *);
257extern void nic_query_multicast(const nic_t *,
258 nic_multicast_mode_t *, size_t, nic_address_t *, size_t *);
259extern void nic_query_broadcast(const nic_t *, nic_broadcast_mode_t *);
260extern void nic_query_blocked_sources(const nic_t *,
261 size_t, nic_address_t *, size_t *);
262extern int nic_query_vlan_mask(const nic_t *, nic_vlan_mask_t *);
263extern int nic_query_wol_max_caps(const nic_t *, nic_wv_type_t);
264extern void nic_set_wol_max_caps(nic_t *, nic_wv_type_t, int);
265extern uint64_t nic_mcast_hash(const nic_address_t *, size_t);
266extern uint64_t nic_query_mcast_hash(nic_t *);
267
268/* Software period functions */
269extern void nic_sw_period_start(nic_t *);
270extern void nic_sw_period_stop(nic_t *);
271
272#endif // __NIC_H__
273
274/** @}
275 */
Note: See TracBrowser for help on using the repository browser.