source: mainline/uspace/lib/nic/include/nic.h@ c99d470

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since c99d470 was 77ad86c, checked in by Martin Decky <martin@…>, 13 years ago

cstyle (no change in functionality)
  • Property mode set to 100644
File size: 10.0 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/**
87 * The handler for transitions between driver states.
88 * If the handler returns negative error code, the transition between
89 * states is canceled (the state is not changed).
90 *
91 * @param nic_data NICF main structure
92 *
93 * @return EOK If everything is all right.
94 * @return negative error code on error.
95 */
96typedef int (*state_change_handler)(nic_t *);
97
98/**
99 * Handler for unicast filtering mode change.
100 *
101 * @param nic_data NICF main structure
102 * @param new_mode The mode that should be set up
103 * @param address_list Addresses as argument to the mode
104 * @param address_count Number of addresses in the list
105 *
106 * @return EOK If the mode is set up
107 * @return ENOTSUP If this mode is not supported
108 */
109typedef int (*unicast_mode_change_handler)(nic_t *,
110 nic_unicast_mode_t, const nic_address_t *, size_t);
111
112/**
113 * Handler for multicast filtering mode change.
114 *
115 * @param nic_data NICF main structure
116 * @param new_mode The mode that should be set up
117 * @param address_list Addresses as argument to the mode
118 * @param address_count Number of addresses in the list
119 *
120 * @return EOK If the mode is set up
121 * @return ENOTSUP If this mode is not supported
122 */
123typedef int (*multicast_mode_change_handler)(nic_t *,
124 nic_multicast_mode_t, const nic_address_t *, size_t);
125
126/**
127 * Handler for broadcast filtering mode change.
128 *
129 * @param nic_data NICF main structure
130 * @param new_mode The mode that should be set up
131 *
132 * @return EOK If the mode is set up
133 * @return ENOTSUP If this mode is not supported
134 */
135typedef int (*broadcast_mode_change_handler)(nic_t *, nic_broadcast_mode_t);
136
137/**
138 * Handler for blocked sources list change.
139 *
140 * @param nic_data NICF main structure
141 * @param address_list Addresses as argument to the mode
142 * @param address_count Number of addresses in the list
143 */
144typedef void (*blocked_sources_change_handler)(nic_t *,
145 const nic_address_t *, size_t);
146
147/**
148 * Handler for VLAN filtering mask change.
149 * @param nic_data NICF main structure
150 * @param vlan_mask The new mask | NULL for disabling vlan filter
151 */
152typedef void (*vlan_mask_change_handler)(nic_t *, const nic_vlan_mask_t *);
153
154/**
155 * Handler called when a WOL virtue is added.
156 * If the maximum of accepted WOL virtues changes due to adding this virtue
157 * you should update the vector wol_virtues.caps_max.
158 * The driver is allowed to store pointer to the virtue data until
159 * on_wol_virtue_remove on these data is called (although probably this is
160 * not a good practice).
161 *
162 * @param nic_data NICF main structure
163 * @param virtue Structure with virtue description
164 *
165 * @return EOK If the filter can be used. Software emulation of the
166 * filter is activated unless the emulate is set to 0.
167 * @return ENOTSUP If this filter cannot work on this NIC (e.g. the NIC
168 * cannot run in promiscuous node or the limit of WOL
169 * frames' specifications was reached).
170 * @return ELIMIT If this filter must implemented in HW but currently the
171 * limit of these HW filters was reached.
172 */
173typedef int (*wol_virtue_add_handler)(nic_t *, const nic_wol_virtue_t *);
174
175/**
176 * Handler called when a WOL virtue is removed.
177 * If the maximum of accepted WOL virtues changes due to removing this
178 * virtue you should update the vector wol_virtues.caps_max.
179 *
180 * @param nic_data NICF main structure
181 * @param virtue Structure with virtue description
182 */
183typedef void (*wol_virtue_remove_handler)(nic_t *, const nic_wol_virtue_t *);
184
185/**
186 * Handler for poll mode change.
187 *
188 * @param nic_data NICF main structure
189 * @param mode Mode to be set up
190 * @param period New period of polling (with NIC_POLL_PERIODIC)
191 *
192 * @return EOK If the mode was fully setup
193 * @return ENOTSUP If NICF should do the periodic polling
194 * @return EINVAL If this mode cannot be set up under no circumstances
195 */
196typedef int (*poll_mode_change_handler)(nic_t *,
197 nic_poll_mode_t, const struct timeval *);
198
199/**
200 * Event handler called when the NIC should poll its buffers for a new frame
201 * (in NIC_POLL_PERIODIC or NIC_POLL_ON_DEMAND) modes.
202 *
203 * @param nic_data NICF main structure
204 */
205typedef void (*poll_request_handler)(nic_t *);
206
207/* nic_t allocation and deallocation */
208extern nic_t *nic_create_and_bind(ddf_dev_t *);
209extern void nic_unbind_and_destroy(ddf_dev_t *);
210
211/* Functions called in the main function */
212extern int nic_driver_init(const char *);
213extern void nic_driver_implement(driver_ops_t *, ddf_dev_ops_t *,
214 nic_iface_t *);
215
216/* Functions called in add_device */
217extern int nic_connect_to_services(nic_t *);
218extern int nic_get_resources(nic_t *, hw_res_list_parsed_t *);
219extern void nic_set_specific(nic_t *, void *);
220extern void nic_set_send_frame_handler(nic_t *, send_frame_handler);
221extern void nic_set_state_change_handlers(nic_t *,
222 state_change_handler, state_change_handler, state_change_handler);
223extern void nic_set_filtering_change_handlers(nic_t *,
224 unicast_mode_change_handler, multicast_mode_change_handler,
225 broadcast_mode_change_handler, blocked_sources_change_handler,
226 vlan_mask_change_handler);
227extern void nic_set_wol_virtue_change_handlers(nic_t *,
228 wol_virtue_add_handler, wol_virtue_remove_handler);
229extern void nic_set_poll_handlers(nic_t *,
230 poll_mode_change_handler, poll_request_handler);
231
232/* General driver functions */
233extern ddf_dev_t *nic_get_ddf_dev(nic_t *);
234extern ddf_fun_t *nic_get_ddf_fun(nic_t *);
235extern void nic_set_ddf_fun(nic_t *, ddf_fun_t *);
236extern nic_t *nic_get_from_ddf_dev(ddf_dev_t *);
237extern nic_t *nic_get_from_ddf_fun(ddf_fun_t *);
238extern void *nic_get_specific(nic_t *);
239extern nic_device_state_t nic_query_state(nic_t *);
240extern void nic_set_tx_busy(nic_t *, int);
241extern int nic_report_address(nic_t *, const nic_address_t *);
242extern int nic_report_poll_mode(nic_t *, nic_poll_mode_t, struct timeval *);
243extern void nic_query_address(nic_t *, nic_address_t *);
244extern void nic_received_frame(nic_t *, nic_frame_t *);
245extern void nic_received_frame_list(nic_t *, nic_frame_list_t *);
246extern void nic_disable_interrupt(nic_t *, int);
247extern void nic_enable_interrupt(nic_t *, int);
248extern nic_poll_mode_t nic_query_poll_mode(nic_t *, struct timeval *);
249
250/* Statistics updates */
251extern void nic_report_send_ok(nic_t *, size_t, size_t);
252extern void nic_report_send_error(nic_t *, nic_send_error_cause_t, unsigned);
253extern void nic_report_receive_error(nic_t *, nic_receive_error_cause_t,
254 unsigned);
255extern void nic_report_collisions(nic_t *, unsigned);
256
257/* Frame / frame list allocation and deallocation */
258extern nic_frame_t *nic_alloc_frame(nic_t *, size_t);
259extern nic_frame_list_t *nic_alloc_frame_list(void);
260extern void nic_frame_list_append(nic_frame_list_t *, nic_frame_t *);
261extern void nic_release_frame(nic_t *, nic_frame_t *);
262
263/* RXC query and report functions */
264extern void nic_report_hw_filtering(nic_t *, int, int, int);
265extern void nic_query_unicast(const nic_t *,
266 nic_unicast_mode_t *, size_t, nic_address_t *, size_t *);
267extern void nic_query_multicast(const nic_t *,
268 nic_multicast_mode_t *, size_t, nic_address_t *, size_t *);
269extern void nic_query_broadcast(const nic_t *, nic_broadcast_mode_t *);
270extern void nic_query_blocked_sources(const nic_t *,
271 size_t, nic_address_t *, size_t *);
272extern int nic_query_vlan_mask(const nic_t *, nic_vlan_mask_t *);
273extern int nic_query_wol_max_caps(const nic_t *, nic_wv_type_t);
274extern void nic_set_wol_max_caps(nic_t *, nic_wv_type_t, int);
275extern uint64_t nic_mcast_hash(const nic_address_t *, size_t);
276extern uint64_t nic_query_mcast_hash(nic_t *);
277
278/* Software period functions */
279extern void nic_sw_period_start(nic_t *);
280extern void nic_sw_period_stop(nic_t *);
281
282#endif // __NIC_H__
283
284/** @}
285 */
Note: See TracBrowser for help on using the repository browser.