xref: /illumos-gate/usr/src/uts/common/sys/mac_provider.h (revision 915894ef19890baaed00080f85f6b69e225cda98)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright (c) 2018, Joyent, Inc.
25  * Copyright 2020 RackTop Systems, Inc.
26  */
27 
28 #ifndef	_SYS_MAC_PROVIDER_H
29 #define	_SYS_MAC_PROVIDER_H
30 
31 #include <sys/types.h>
32 #include <sys/ddi.h>
33 #include <sys/sunddi.h>
34 #include <sys/stream.h>
35 #include <sys/mkdev.h>
36 #include <sys/mac.h>
37 #include <sys/mac_flow.h>
38 
39 /*
40  * MAC Provider Interface
41  */
42 
43 #ifdef	__cplusplus
44 extern "C" {
45 #endif
46 
47 /*
48  * MAC version identifiers. Drivers compiled against the stable V1 version
49  * of the API should register with MAC_VERSION_V1. ON drivers should use
50  * MAC_VERSION. This is used by mac_alloc() mac_register() to
51  * verify that incompatible drivers don't register.
52  */
53 #define	MAC_VERSION_V1	0x1
54 #define	MAC_VERSION	MAC_VERSION_V1
55 
56 /*
57  * Possible values for ETHER_STAT_XCVR_INUSE statistic.
58  */
59 
60 #define	XCVR_UNDEFINED		0
61 #define	XCVR_NONE		1
62 #define	XCVR_10			2
63 #define	XCVR_100T4		3
64 #define	XCVR_100X		4
65 #define	XCVR_100T2		5
66 #define	XCVR_1000X		6
67 #define	XCVR_1000T		7
68 
69 #ifdef	_KERNEL
70 
71 /*
72  * Definitions for MAC Drivers Capabilities
73  */
74 /*
75  * MAC layer capabilities.  These capabilities are handled by the drivers'
76  * mc_capab_get() callbacks.  Some capabilities require the driver to fill
77  * in a given data structure, and others are simply boolean capabilities.
78  * Note that capability values must be powers of 2 so that consumers and
79  * providers of this interface can keep track of which capabilities they
80  * care about by keeping a bitfield of these things around somewhere.
81  */
82 typedef enum {
83 	/*
84 	 * Public Capabilities (MAC_VERSION_V1)
85 	 */
86 	MAC_CAPAB_HCKSUM	= 0x00000001, /* data is a uint32_t */
87 	MAC_CAPAB_LSO		= 0x00000008, /* data is mac_capab_lso_t */
88 
89 	/*
90 	 * Reserved capabilities, do not use
91 	 */
92 	MAC_CAPAB_RESERVED1	= 0x00000002,
93 	MAC_CAPAB_RESERVED2	= 0x00000004,
94 
95 	/*
96 	 * Private driver capabilities
97 	 */
98 	MAC_CAPAB_RINGS		= 0x00000010, /* data is mac_capab_rings_t */
99 	MAC_CAPAB_SHARES	= 0x00000020, /* data is mac_capab_share_t */
100 	MAC_CAPAB_MULTIFACTADDR = 0x00000040, /* mac_data_multifactaddr_t */
101 
102 	/*
103 	 * Private driver capabilities for use by the GLDv3 framework only
104 	 */
105 	MAC_CAPAB_VNIC		= 0x00010000, /* data is mac_capab_vnic_t */
106 	MAC_CAPAB_ANCHOR_VNIC	= 0x00020000, /* boolean only, no data */
107 	MAC_CAPAB_AGGR		= 0x00040000, /* data is mac_capab_aggr_t */
108 	MAC_CAPAB_NO_NATIVEVLAN	= 0x00080000, /* boolean only, no data */
109 	MAC_CAPAB_NO_ZCOPY	= 0x00100000, /* boolean only, no data */
110 	MAC_CAPAB_LEGACY	= 0x00200000, /* data is mac_capab_legacy_t */
111 	MAC_CAPAB_VRRP		= 0x00400000, /* data is mac_capab_vrrp_t */
112 	MAC_CAPAB_TRANSCEIVER	= 0x01000000, /* mac_capab_transciever_t */
113 	MAC_CAPAB_LED		= 0x02000000  /* data is mac_capab_led_t */
114 } mac_capab_t;
115 
116 /*
117  * LSO capability
118  */
119 typedef struct lso_basic_tcp_ipv4_s {
120 	t_uscalar_t	lso_max;		/* maximum payload */
121 } lso_basic_tcp_ipv4_t;
122 
123 typedef struct lso_basic_tcp_ipv6_s {
124 	t_uscalar_t	lso_max;		/* maximum payload */
125 } lso_basic_tcp_ipv6_t;
126 
127 /*
128  * Currently supported flags for LSO.
129  */
130 #define	LSO_TX_BASIC_TCP_IPV4	0x01		/* TCPv4 LSO capability */
131 #define	LSO_TX_BASIC_TCP_IPV6	0x02		/* TCPv6 LSO capability */
132 
133 /*
134  * Future LSO capabilities can be added at the end of the mac_capab_lso_t.
135  * When such capability is added to the GLDv3 framework, the size of the
136  * mac_capab_lso_t it allocates and passes to the drivers increases. Older
137  * drivers wil access only the (upper) sections of that structure, that is the
138  * sections carrying the capabilities they understand. This ensures the
139  * interface can be safely extended in a binary compatible way.
140  */
141 typedef	struct mac_capab_lso_s {
142 	t_uscalar_t		lso_flags;
143 	lso_basic_tcp_ipv4_t	lso_basic_tcp_ipv4;
144 	lso_basic_tcp_ipv6_t	lso_basic_tcp_ipv6;
145 	/* Add future lso capabilities here */
146 } mac_capab_lso_t;
147 
148 /*
149  * Multiple Factory MAC Addresses Capability
150  */
151 typedef struct mac_capab_multifactaddr_s {
152 	/*
153 	 * Number of factory addresses
154 	 */
155 	uint_t		mcm_naddr;
156 
157 	/*
158 	 * Callbacks to query all the factory addresses.
159 	 */
160 	void		(*mcm_getaddr)(void *, uint_t, uint8_t *);
161 } mac_capab_multifactaddr_t;
162 
163 /*
164  * Info and callbacks of legacy devices.
165  */
166 typedef struct mac_capab_legacy_s {
167 	/*
168 	 * Notifications that the legacy device does not support.
169 	 */
170 	uint32_t	ml_unsup_note;
171 	/*
172 	 * dev_t of the legacy device; can be held to force attach.
173 	 */
174 	dev_t		ml_dev;
175 	boolean_t	(*ml_active_set)(void *);
176 	void		(*ml_active_clear)(void *);
177 	int		(*ml_fastpath_disable)(void *);
178 	void		(*ml_fastpath_enable)(void *);
179 } mac_capab_legacy_t;
180 
181 typedef struct __mac_prop_info_handle *mac_prop_info_handle_t;
182 
183 /*
184  * MAC driver entry point types.
185  */
186 typedef int		(*mac_getstat_t)(void *, uint_t, uint64_t *);
187 typedef	int		(*mac_start_t)(void *);
188 typedef void		(*mac_stop_t)(void *);
189 typedef int		(*mac_setpromisc_t)(void *, boolean_t);
190 typedef int		(*mac_multicst_t)(void *, boolean_t, const uint8_t *);
191 typedef int		(*mac_unicst_t)(void *, const uint8_t *);
192 typedef void		(*mac_ioctl_t)(void *, queue_t *, mblk_t *);
193 typedef void		(*mac_resources_t)(void *);
194 typedef mblk_t		*(*mac_tx_t)(void *, mblk_t *);
195 typedef	boolean_t	(*mac_getcapab_t)(void *, mac_capab_t, void *);
196 typedef	int		(*mac_open_t)(void *);
197 typedef void		(*mac_close_t)(void *);
198 typedef	int		(*mac_set_prop_t)(void *, const char *, mac_prop_id_t,
199 			    uint_t, const void *);
200 typedef	int		(*mac_get_prop_t)(void *, const char *, mac_prop_id_t,
201 			    uint_t, void *);
202 typedef void		(*mac_prop_info_t)(void *, const char *, mac_prop_id_t,
203 			    mac_prop_info_handle_t);
204 
205 /*
206  * Driver callbacks. The following capabilities are optional, and if
207  * implemented by the driver, must have a corresponding MC_ flag set
208  * in the mc_callbacks field.
209  *
210  * Any future additions to this list must also be accompanied by an
211  * associated mc_callbacks flag so that the framework can grow without
212  * affecting the binary compatibility of the interface.
213  */
214 typedef struct mac_callbacks_s {
215 	uint_t		mc_callbacks;	/* Denotes which callbacks are set */
216 	mac_getstat_t	mc_getstat;	/* Get the value of a statistic */
217 	mac_start_t	mc_start;	/* Start the device */
218 	mac_stop_t	mc_stop;	/* Stop the device */
219 	mac_setpromisc_t mc_setpromisc;	/* Enable or disable promiscuous mode */
220 	mac_multicst_t	mc_multicst;	/* Enable or disable a multicast addr */
221 	mac_unicst_t	mc_unicst;	/* Set the unicast MAC address */
222 	mac_tx_t	mc_tx;		/* Transmit a packet */
223 	void		*mc_reserved;	/* Reserved, do not use */
224 	mac_ioctl_t	mc_ioctl;	/* Process an unknown ioctl */
225 	mac_getcapab_t	mc_getcapab;	/* Get capability information */
226 	mac_open_t	mc_open;	/* Open the device */
227 	mac_close_t	mc_close;	/* Close the device */
228 	mac_set_prop_t	mc_setprop;
229 	mac_get_prop_t	mc_getprop;
230 	mac_prop_info_t	mc_propinfo;
231 } mac_callbacks_t;
232 
233 /*
234  * Flags for mc_callbacks.  Requiring drivers to set the flags associated
235  * with optional callbacks initialized in the structure allows the mac
236  * module to add optional callbacks in the future without requiring drivers
237  * to recompile.
238  */
239 #define	MC_RESERVED	0x0001
240 #define	MC_IOCTL	0x0002
241 #define	MC_GETCAPAB	0x0004
242 #define	MC_OPEN		0x0008
243 #define	MC_CLOSE	0x0010
244 #define	MC_SETPROP	0x0020
245 #define	MC_GETPROP	0x0040
246 #define	MC_PROPINFO	0x0080
247 #define	MC_PROPERTIES	(MC_SETPROP | MC_GETPROP | MC_PROPINFO)
248 
249 /*
250  * Virtualization Capabilities
251  */
252 
253 /*
254  * The type of ring classification. This is used by MAC to determine
255  * what, if any, processing it has to do upon receiving traffic on a
256  * particular Rx ring.
257  *
258  * MAC_NO_CLASSIFIER
259  *
260  *	No classification has been set. No traffic should cross an Rx
261  *	ring in this state.
262  *
263  * MAC_SW_CLASSIFIER
264  *
265  *	The driver delivers traffic for multiple clients to this ring.
266  *	All traffic must be software classified by MAC to guarantee
267  *	delivery to the correct client. This classification type may
268  *	be chosen for several reasons.
269  *
270  *	o The driver provides only one group and there are multiple
271  *	  clients using the MAC.
272  *
273  *	o The driver provides some hardware filtering but not enough
274  *	  to fully classify the traffic. E.g., a VLAN VNIC requires L2
275  *	  unicast address filtering as well as VLAN filtering, but
276  *	  some drivers may only support the former.
277  *
278  *	o The ring belongs to the default group. The default group
279  *	  acts as a spillover for all clients that can't reserve an
280  *	  exclusive group. It also handles multicast traffic for all
281  *	  clients. For these reasons, the default group's rings are
282  *	  always software classified.
283  *
284  * MAC_HW_CLASSIFIER
285  *
286  *	The driver delivers traffic for a single MAC client across
287  *	this ring. With this guarantee, MAC can simply pass the
288  *	traffic up the stack or even allow polling of the ring.
289  *
290  * MAC_PASSTHRU_CLASSIFIER
291  *
292  *	The ring is in "passthru" mode. In this mode we bypass all of
293  *	the typical MAC processing and pass the traffic directly to
294  *	the mr_pt_fn callback, see mac_rx_common(). This is used in
295  *	cases where there is another module acting as MAC provider on
296  *	behalf of the driver. E.g., link aggregations use this mode to
297  *	take full control of the port's rings; allowing it to enforce
298  *	LACP protocols and aggregate rings across discrete drivers.
299  */
300 typedef enum {
301 	MAC_NO_CLASSIFIER = 0,
302 	MAC_SW_CLASSIFIER,
303 	MAC_HW_CLASSIFIER,
304 	MAC_PASSTHRU_CLASSIFIER
305 } mac_classify_type_t;
306 
307 typedef	void	(*mac_rx_func_t)(void *, mac_resource_handle_t, mblk_t *,
308     boolean_t);
309 
310 /*
311  * The virtualization level conveys the extent of the NIC hardware assistance
312  * for traffic steering employed for virtualization:
313  *
314  * MAC_VIRT_NONE:	No assist for v12n.
315  *
316  * MAC_VIRT_LEVEL1:	Multiple Rx rings with MAC address level
317  *			classification between groups of rings.
318  *			Requires the support of the MAC_CAPAB_RINGS
319  *			capability.
320  *
321  * MAC_VIRT_HIO:	Hybrid I/O capable MAC. Require the support
322  *			of the MAC_CAPAB_SHARES capability.
323  */
324 #define	MAC_VIRT_NONE		0x0
325 #define	MAC_VIRT_LEVEL1		0x1
326 #define	MAC_VIRT_HIO		0x2
327 
328 typedef enum {
329 	MAC_RING_TYPE_RX = 1,	/* Receive ring */
330 	MAC_RING_TYPE_TX	/* Transmit ring */
331 } mac_ring_type_t;
332 
333 /*
334  * The value VLAN_ID_NONE (VID 0) means a client does not have
335  * membership to any VLAN. However, this statement is true for both
336  * untagged packets and priority tagged packets leading to confusion
337  * over what semantic is intended. To the provider, VID 0 is a valid
338  * VID when priority tagging is in play. To MAC and everything above
339  * VLAN_ID_NONE almost universally implies untagged traffic. Thus, we
340  * convert VLAN_ID_NONE to a sentinel value (MAC_VLAN_UNTAGGED) at the
341  * border between MAC and MAC provider. This informs the provider that
342  * the client is interested in untagged traffic and the provider
343  * should set any relevant bits to receive such traffic.
344  *
345  * Currently, the API between MAC and the provider passes the VID as a
346  * unit16_t. In the future this could actually be the entire TCI mask
347  * (PCP, DEI, and VID). This current scheme is safe in that potential
348  * future world as well; as 0xFFFF is not a valid TCI (the 0xFFF VID
349  * is reserved and never transmitted across networks).
350  */
351 #define	MAC_VLAN_UNTAGGED		UINT16_MAX
352 #define	MAC_VLAN_UNTAGGED_VID(vid)	\
353 	(((vid) == VLAN_ID_NONE) ? MAC_VLAN_UNTAGGED : (vid))
354 
355 /*
356  * Grouping type of a ring group
357  *
358  * MAC_GROUP_TYPE_STATIC: The ring group can not be re-grouped.
359  * MAC_GROUP_TYPE_DYNAMIC: The ring group support dynamic re-grouping
360  */
361 typedef enum {
362 	MAC_GROUP_TYPE_STATIC = 1,	/* Static ring group */
363 	MAC_GROUP_TYPE_DYNAMIC		/* Dynamic ring group */
364 } mac_group_type_t;
365 
366 typedef	struct __mac_ring_driver	*mac_ring_driver_t;
367 typedef	struct __mac_group_driver	*mac_group_driver_t;
368 
369 typedef	struct mac_ring_info_s mac_ring_info_t;
370 typedef	struct mac_group_info_s mac_group_info_t;
371 
372 typedef void	(*mac_get_ring_t)(void *, mac_ring_type_t, const int, const int,
373     mac_ring_info_t *, mac_ring_handle_t);
374 typedef void	(*mac_get_group_t)(void *, mac_ring_type_t, const int,
375     mac_group_info_t *, mac_group_handle_t);
376 
377 typedef void	(*mac_group_add_ring_t)(mac_group_driver_t,
378     mac_ring_driver_t, mac_ring_type_t);
379 typedef void	(*mac_group_rem_ring_t)(mac_group_driver_t,
380     mac_ring_driver_t, mac_ring_type_t);
381 
382 /*
383  * Multiple Rings Capability
384  */
385 typedef struct	mac_capab_rings_s {
386 	mac_ring_type_t		mr_type;	/* Ring type: Rx vs Tx */
387 	mac_group_type_t	mr_group_type;	/* Dynamic vs static grouping */
388 	uint_t			mr_rnum;	/* Number of rings */
389 	uint_t			mr_gnum;	/* Number of ring groups */
390 	mac_get_ring_t		mr_rget;	/* Get ring from driver */
391 	mac_get_group_t		mr_gget;	/* Get ring group from driver */
392 	mac_group_add_ring_t	mr_gaddring;	/* Add ring into a group */
393 	mac_group_rem_ring_t	mr_gremring;	/* Remove ring from a group */
394 } mac_capab_rings_t;
395 
396 /*
397  * Common ring functions and driver interfaces
398  */
399 typedef	int	(*mac_ring_start_t)(mac_ring_driver_t, uint64_t);
400 typedef	void	(*mac_ring_stop_t)(mac_ring_driver_t);
401 
402 typedef	mblk_t	*(*mac_ring_send_t)(void *, mblk_t *);
403 typedef	mblk_t	*(*mac_ring_poll_t)(void *, int);
404 
405 typedef int	(*mac_ring_stat_t)(mac_ring_driver_t, uint_t, uint64_t *);
406 
407 typedef struct mac_ring_info_s {
408 	mac_ring_driver_t	mri_driver;
409 	mac_ring_start_t	mri_start;
410 	mac_ring_stop_t		mri_stop;
411 	mac_intr_t		mri_intr;
412 	union {
413 		mac_ring_send_t	send;
414 		mac_ring_poll_t	poll;
415 	} mrfunion;
416 	mac_ring_stat_t		mri_stat;
417 
418 	/*
419 	 * mri_flags will have some bits set to indicate some special
420 	 * property/feature of a ring like serialization needed for a
421 	 * Tx ring or packets should always need enqueuing on Rx side,
422 	 * etc.
423 	 */
424 	uint_t			mri_flags;
425 } mac_ring_info_s;
426 
427 #define	mri_tx			mrfunion.send
428 #define	mri_poll		mrfunion.poll
429 
430 /*
431  * #defines for mri_flags. The flags are temporary flags that are provided
432  * only to workaround issues in specific drivers, and they will be
433  * removed in the future.
434  *
435  * These are consumed only by sun4v and neptune (nxge).
436  */
437 #define	MAC_RING_TX_SERIALIZE		0x1
438 #define	MAC_RING_RX_ENQUEUE		0x2
439 
440 typedef	int	(*mac_group_start_t)(mac_group_driver_t);
441 typedef	void	(*mac_group_stop_t)(mac_group_driver_t);
442 typedef	int	(*mac_add_mac_addr_t)(void *, const uint8_t *);
443 typedef	int	(*mac_rem_mac_addr_t)(void *, const uint8_t *);
444 typedef int	(*mac_add_vlan_filter_t)(mac_group_driver_t, uint16_t);
445 typedef int	(*mac_rem_vlan_filter_t)(mac_group_driver_t, uint16_t);
446 
447 struct mac_group_info_s {
448 	mac_group_driver_t	mgi_driver;	/* Driver reference */
449 	mac_group_start_t	mgi_start;	/* Start the group */
450 	mac_group_stop_t	mgi_stop;	/* Stop the group */
451 	uint_t			mgi_count;	/* Count of rings */
452 	mac_intr_t		mgi_intr;	/* Optional per-group intr */
453 
454 	/* Only used for Rx groups */
455 	mac_add_mac_addr_t	mgi_addmac;	/* Add a MAC address */
456 	mac_rem_mac_addr_t	mgi_remmac;	/* Remove a MAC address */
457 	mac_add_vlan_filter_t	mgi_addvlan;	/* Add a VLAN filter */
458 	mac_rem_vlan_filter_t	mgi_remvlan;	/* Remove a VLAN filter */
459 };
460 
461 /*
462  * Share management functions.
463  */
464 typedef uint64_t mac_share_handle_t;
465 
466 /*
467  * Allocate and free a share. Returns ENOSPC if all shares have been
468  * previously allocated.
469  */
470 typedef int (*mac_alloc_share_t)(void *, mac_share_handle_t *);
471 typedef void (*mac_free_share_t)(mac_share_handle_t);
472 
473 /*
474  * Bind and unbind a share. Binding a share allows a domain
475  * to have direct access to the groups and rings associated with
476  * that share.
477  */
478 typedef int (*mac_bind_share_t)(mac_share_handle_t, uint64_t, uint64_t *);
479 typedef void (*mac_unbind_share_t)(mac_share_handle_t);
480 
481 /*
482  * Return information on about a share.
483  */
484 typedef void (*mac_share_query_t)(mac_share_handle_t, mac_ring_type_t,
485     mac_ring_handle_t *, uint_t *);
486 
487 /*
488  * Basic idea, bind previously created ring groups to shares
489  * for them to be exported (or shared) by another domain.
490  * These interfaces bind/unbind the ring group to a share.
491  * The groups and their rings will be shared with the guest
492  * as soon as the share is bound.
493  */
494 typedef int (*mac_share_add_group_t)(mac_share_handle_t,
495     mac_group_driver_t);
496 typedef int (*mac_share_rem_group_t)(mac_share_handle_t,
497     mac_group_driver_t);
498 
499 typedef struct  mac_capab_share_s {
500 	uint_t			ms_snum;	/* Number of shares (vr's) */
501 	void			*ms_handle;	/* Handle to driver. */
502 	mac_alloc_share_t	ms_salloc;	/* Get a share from driver. */
503 	mac_free_share_t	ms_sfree;	/* Return a share to driver. */
504 	mac_share_add_group_t	ms_sadd;	/* Add a group to the share. */
505 	mac_share_rem_group_t	ms_sremove;	/* Remove group from share. */
506 	mac_share_query_t	ms_squery;	/* Query share constraints */
507 	mac_bind_share_t	ms_sbind;	/* Bind a share */
508 	mac_unbind_share_t	ms_sunbind;	/* Unbind a share */
509 } mac_capab_share_t;
510 
511 typedef struct mac_capab_vrrp_s {
512 	/* IPv6 or IPv4? */
513 	int		mcv_af;
514 } mac_capab_vrrp_t;
515 
516 /*
517  * Transceiver capability
518  */
519 typedef struct mac_transceiver_info mac_transceiver_info_t;
520 
521 typedef struct mac_capab_transceiver {
522 	uint_t	mct_flags;
523 	uint_t	mct_ntransceivers;
524 	int	(*mct_info)(void *, uint_t, mac_transceiver_info_t *);
525 	int	(*mct_read)(void *, uint_t, uint_t, void *, size_t, off_t,
526 		    size_t *);
527 } mac_capab_transceiver_t;
528 
529 /*
530  * LED capability
531  */
532 typedef struct mac_capab_led {
533 	uint_t		mcl_flags;
534 	mac_led_mode_t	mcl_modes;
535 	int		(*mcl_set)(void *, mac_led_mode_t, uint_t);
536 } mac_capab_led_t;
537 
538 /*
539  * MAC registration interface
540  */
541 typedef struct mac_register_s {
542 	uint_t			m_version;	/* set by mac_alloc() */
543 	const char		*m_type_ident;
544 	void			*m_driver;	/* Driver private data */
545 	dev_info_t		*m_dip;
546 	uint_t			m_instance;
547 	uint8_t			*m_src_addr;
548 	uint8_t			*m_dst_addr;
549 	mac_callbacks_t		*m_callbacks;
550 	uint_t			m_min_sdu;
551 	uint_t			m_max_sdu;
552 	void			*m_pdata;
553 	size_t			m_pdata_size;
554 	char			**m_priv_props;
555 	uint32_t		m_margin;
556 	uint32_t		m_v12n;		/* Virtualization level */
557 	uint_t			m_multicast_sdu;
558 } mac_register_t;
559 
560 /*
561  * Driver interface functions.
562  */
563 extern mac_protect_t		*mac_protect_get(mac_handle_t);
564 extern void			mac_sdu_get(mac_handle_t, uint_t *, uint_t *);
565 extern void			mac_sdu_get2(mac_handle_t, uint_t *, uint_t *,
566 				    uint_t *);
567 extern int			mac_maxsdu_update(mac_handle_t, uint_t);
568 extern int			mac_maxsdu_update2(mac_handle_t, uint_t,
569 				    uint_t);
570 
571 extern mac_register_t		*mac_alloc(uint_t);
572 extern void			mac_free(mac_register_t *);
573 extern int			mac_register(mac_register_t *, mac_handle_t *);
574 extern int			mac_disable_nowait(mac_handle_t);
575 extern int			mac_disable(mac_handle_t);
576 extern int			mac_unregister(mac_handle_t);
577 extern void			mac_rx(mac_handle_t, mac_resource_handle_t,
578 				    mblk_t *);
579 extern void			mac_rx_ring(mac_handle_t, mac_ring_handle_t,
580 				    mblk_t *, uint64_t);
581 extern void			mac_link_update(mac_handle_t, link_state_t);
582 extern void			mac_link_redo(mac_handle_t, link_state_t);
583 extern void			mac_unicst_update(mac_handle_t,
584 				    const uint8_t *);
585 extern void			mac_dst_update(mac_handle_t, const uint8_t *);
586 extern void			mac_tx_update(mac_handle_t);
587 extern void			mac_tx_ring_update(mac_handle_t,
588 				    mac_ring_handle_t);
589 extern void			mac_capab_update(mac_handle_t);
590 extern int			mac_pdata_update(mac_handle_t, void *,
591 				    size_t);
592 extern void			mac_multicast_refresh(mac_handle_t,
593 				    mac_multicst_t, void *, boolean_t);
594 extern void			mac_unicst_refresh(mac_handle_t, mac_unicst_t,
595 				    void *);
596 extern void			mac_promisc_refresh(mac_handle_t,
597 				    mac_setpromisc_t, void *);
598 extern boolean_t		mac_margin_update(mac_handle_t, uint32_t);
599 extern void			mac_margin_get(mac_handle_t, uint32_t *);
600 extern int			mac_margin_remove(mac_handle_t, uint32_t);
601 extern int			mac_margin_add(mac_handle_t, uint32_t *,
602 				    boolean_t);
603 extern void			mac_init_ops(struct dev_ops *, const char *);
604 extern void			mac_fini_ops(struct dev_ops *);
605 extern int			mac_devt_to_instance(dev_t);
606 extern minor_t			mac_private_minor(void);
607 extern void			mac_ring_intr_set(mac_ring_handle_t,
608 				    ddi_intr_handle_t);
609 
610 
611 extern mactype_register_t	*mactype_alloc(uint_t);
612 extern void			mactype_free(mactype_register_t *);
613 extern int			mactype_register(mactype_register_t *);
614 extern int			mactype_unregister(const char *);
615 
616 extern boolean_t		mac_unicst_verify(mac_handle_t,
617 				    const uint8_t *, uint_t);
618 
619 extern int			mac_group_add_ring(mac_group_handle_t, int);
620 extern void			mac_group_rem_ring(mac_group_handle_t,
621 				    mac_ring_handle_t);
622 extern mac_ring_handle_t	mac_find_ring(mac_group_handle_t, int);
623 
624 extern void			mac_prop_info_set_default_uint8(
625 				    mac_prop_info_handle_t, uint8_t);
626 extern void			mac_prop_info_set_default_str(
627 				    mac_prop_info_handle_t, const char *);
628 extern void			mac_prop_info_set_default_uint64(
629 				    mac_prop_info_handle_t, uint64_t);
630 extern void			mac_prop_info_set_default_uint32(
631 				    mac_prop_info_handle_t, uint32_t);
632 extern void			mac_prop_info_set_default_link_flowctrl(
633 				    mac_prop_info_handle_t, link_flowctrl_t);
634 extern void			mac_prop_info_set_default_fec(
635 				    mac_prop_info_handle_t, link_fec_t);
636 extern void			mac_prop_info_set_range_uint32(
637 				    mac_prop_info_handle_t,
638 				    uint32_t, uint32_t);
639 extern void			mac_prop_info_set_perm(mac_prop_info_handle_t,
640 				    uint8_t);
641 
642 extern void			mac_hcksum_get(const mblk_t *, uint32_t *,
643 				    uint32_t *, uint32_t *, uint32_t *,
644 				    uint32_t *);
645 extern void			mac_hcksum_set(mblk_t *, uint32_t, uint32_t,
646 				    uint32_t, uint32_t, uint32_t);
647 extern void			mac_hcksum_clone(const mblk_t *, mblk_t *);
648 
649 extern void			mac_lso_get(mblk_t *, uint32_t *, uint32_t *);
650 
651 extern void			mac_transceiver_info_set_present(
652 				    mac_transceiver_info_t *,
653 				    boolean_t);
654 extern void			mac_transceiver_info_set_usable(
655 				    mac_transceiver_info_t *,
656 				    boolean_t);
657 
658 /*
659  * This represents a provisional set of currently illumos-private APIs to get
660  * information about a mblk_t chain's type. This is an evolving interface.
661  */
662 typedef enum mac_ether_offload_flags {
663 	MEOI_L2INFO_SET		= 1 << 0,
664 	MEOI_VLAN_TAGGED	= 1 << 1,
665 	MEOI_L3INFO_SET		= 1 << 2,
666 	MEOI_L4INFO_SET		= 1 << 3
667 } mac_ether_offload_flags_t;
668 
669 typedef struct mac_ether_offload_info {
670 	mac_ether_offload_flags_t	meoi_flags;	/* What's valid? */
671 	size_t		meoi_len;	/* Total message length */
672 	uint8_t		meoi_l2hlen;	/* How long is the Ethernet header? */
673 	uint16_t	meoi_l3proto;	/* What's the Ethertype */
674 	uint8_t		meoi_l3hlen;	/* How long is the header? */
675 	uint8_t		meoi_l4proto;	/* What is the payload type? */
676 	uint8_t		meoi_l4hlen;	/* How long is the L4 header */
677 } mac_ether_offload_info_t;
678 
679 extern int			mac_ether_offload_info(mblk_t *,
680 				    mac_ether_offload_info_t *);
681 
682 
683 #endif	/* _KERNEL */
684 
685 #ifdef	__cplusplus
686 }
687 #endif
688 
689 #endif /* _SYS_MAC_PROVIDER_H */
690