source: mainline/uspace/lib/nic/include/nic.h@ 9ce251c7

Last change on this file since 9ce251c7 was 9ce251c7, checked in by Nataliia Korop <n.corop08@…>, 10 months ago

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