path: root/usr/src/man/man9s/gld_mac_info.9s

'\" te
.\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH GLD_MAC_INFO 9S "Jun 7, 2004"
.SH NAME
gld_mac_info \- Generic LAN Driver MAC info data structure
.SH SYNOPSIS
.nf
#include <sys/gld.h>
.fi

.SH INTERFACE LEVEL
illumos architecture specific (illumos DDI).
.SH DESCRIPTION
The Generic LAN Driver (GLD) Media Access Control (MAC) information
(\fBgld_mac_info\fR) structure is the main data interface between the
device-specific driver and GLD. It contains data required by GLD and a pointer
to an optional additional driver-specific information structure.
.sp
.LP
The \fBgld_mac_info\fR structure should be allocated using
\fBgld_mac_alloc()\fR and deallocated using \fBgld_mac_free()\fR. Drivers can
make no assumptions about the length of this structure, which might be
different in different releases of illumos and/or GLD. Structure members
private to GLD, not documented here, should not be set or read by the
device-specific driver.
.SH STRUCTURE MEMBERS
.in +2
.nf
caddr_t         gldm_private;              /* Driver private data */
int               (*gldm_reset)();         /* Reset device */
int               (*gldm_start)();         /* Start device */
int               (*gldm_stop)();          /* Stop device */
int               (*gldm_set_mac_addr)();  /* Set device phys addr */
int               (*gldm_set_multicast)(); /* Set/delete */
                                            /* multicast address */
int               (*gldm_set_promiscuous)();
                                            /* Set/reset promiscuous */
                                            /* mode*/
int               (*gldm_send)();          /* Transmit routine */
u_int             (*gldm_intr)();          /* Interrupt handler */
int               (*gldm_get_stats)();     /* Get device statistics */
int               (*gldm_ioctl)();         /* Driver-specific ioctls */
char             *gldm_ident;              /* Driver identity string */
uint32_t          gldm_type;               /* Device type */
uint32_t          gldm_minpkt;             /* Minimum packet size */
                                            /* accepted by driver */
uint32_t          gldm_maxpkt;             /* Maximum packet size */
                                            /* accepted by driver */
uint32_t          gldm_addrlen;            /* Physical address */
                                            /* length */
int32_t           gldm_saplen;             /* SAP length for */
                                            /* DL_INFO_ACK */
unsigned char    *gldm_broadcast_addr;     /* Physical broadcast */
                                            /* addr */
unsigned char    *gldm_vendor_addr;        /* Factory MAC address */
t_uscalar_t       gldm_ppa;                /* Physical Point of */
                                            /* Attachment (PPA) number */
dev_info_t       *gldm_devinfo;            /* Pointer to device's */
                                            /* dev_info node */
ddi_iblock_cookie_tgldm_cookie;            /* Device's interrupt */
                                            /* block cookie */
int               gldm_margin              /* accepted data beyond */
                                            /*gldm_maxpkt */
uint32_t          gldm_capabilities;       /* Device capabilities */
.fi
.in -2
.sp

.sp
.LP
Below is a description of the members of the \fBgld_mac_info\fR structure that
are visible to the device driver.
.sp
.ne 2
.na
\fB\fBgldm_private\fR\fR
.ad
.RS 16n
This structure member is private to the device-specific driver and is not used
or modified by GLD. Conventionally, this is used as a pointer to private data,
pointing to a driver-defined and driver-allocated per-instance data structure.
.RE

.sp
.LP
The following group of structure members must be set by the driver before
calling \fBgld_register()\fR, and should not thereafter be modified by the
driver; \fBgld_register()\fR can use or cache the values of some of these
structure members, so changes made by the driver after calling
\fBgld_register()\fR might cause unpredicted results.
.sp
.ne 2
.na
\fB\fBgldm_reset\fR\fR
.ad
.RS 24n
Pointer to driver entry point; see \fBgld\fR(9E).
.RE

.sp
.ne 2
.na
\fB\fBgldm_start\fR\fR
.ad
.RS 24n
Pointer to driver entry point; see \fBgld\fR(9E).
.RE

.sp
.ne 2
.na
\fB\fBgldm_stop\fR\fR
.ad
.RS 24n
Pointer to driver entry point; see \fBgld\fR(9E).
.RE

.sp
.ne 2
.na
\fB\fBgldm_set_mac_addr\fR\fR
.ad
.RS 24n
Pointer to driver entry point; see \fBgld\fR(9E).
.RE

.sp
.ne 2
.na
\fB\fBgldm_set_multicast\fR\fR
.ad
.RS 24n
Pointer to driver entry point; see \fBgld\fR(9E).
.RE

.sp
.ne 2
.na
\fB\fBgldm_set_promiscuous\fR\fR
.ad
.RS 24n
Pointer to driver entry point; see \fBgld\fR(9E).
.RE

.sp
.ne 2
.na
\fB\fBgldm_send\fR\fR
.ad
.RS 24n
Pointer to driver entry point; see \fBgld\fR(9E).
.RE

.sp
.ne 2
.na
\fB\fBgldm_intr\fR\fR
.ad
.RS 24n
Pointer to driver entry point; see \fBgld\fR(9E).
.RE

.sp
.ne 2
.na
\fB\fBgldm_get_stats\fR\fR
.ad
.RS 24n
Pointer to driver entry point; see \fBgld\fR(9E).
.RE

.sp
.ne 2
.na
\fB\fBgldm_ioctl\fR\fR
.ad
.RS 24n
Pointer to driver entry point; can be \fINULL\fR; see \fBgld\fR(9E).
.RE

.sp
.ne 2
.na
\fB\fBgldm_ident\fR\fR
.ad
.RS 24n
Pointer to a string containing a short description of the device. It is used to
identify the device in system messages.
.RE

.sp
.ne 2
.na
\fB\fBgldm_type\fR\fR
.ad
.RS 24n
The type of device the driver handles. The values currently supported by GLD
are \fBDL_ETHER\fR (IEEE 802.3 and Ethernet Bus), \fBDL_TPR\fR (IEEE 802.5
Token Passing Ring), and \fBDL_FDDI\fR (ISO 9314-2 Fibre Distributed Data
Interface). This structure member must be correctly set for GLD to function
properly.
.sp
Support for the DL_TPR and DL_FDDI media types is obsolete and may be removed
in a future release of illumos.
.RE

.sp
.ne 2
.na
\fB\fBgldm_minpkt\fR\fR
.ad
.RS 24n
Minimum \fIService\fR \fIData\fR \fIUnit\fR size \(em the minimum packet size,
not including the MAC header, that the device will transmit. This can be zero
if the device-specific driver can handle any required padding.
.RE

.sp
.ne 2
.na
\fB\fBgldm_maxpkt\fR\fR
.ad
.RS 24n
Maximum \fIService\fR \fIData\fR \fIUnit\fR size \(em the maximum size of
packet, not including the MAC header, that can be transmitted by the device.
For Ethernet, this number is 1500.
.RE

.sp
.ne 2
.na
\fB\fBgldm_addrlen\fR\fR
.ad
.RS 24n
The length in bytes of physical addresses handled by the device. For Ethernet,
Token Ring, and FDDI, the value of this structure member should be 6.
.RE

.sp
.ne 2
.na
\fB\fBgldm_saplen\fR\fR
.ad
.RS 24n
The length in bytes of the Service Access Point (SAP) address used by the
driver. For GLD-based drivers, this should always be set to -2, to indicate
that two-byte SAP values are supported and that the SAP appears \fIafter\fR the
physical address in a DLSAP address. See the description under ``Message
DL_INFO_ACK'' in the DLPI specification for more details.
.RE

.sp
.ne 2
.na
\fB\fBgldm_broadcast_addr\fR\fR
.ad
.RS 24n
Pointer to an array of bytes of length \fBgldm_addrlen\fR containing the
broadcast address to be used for transmit. The driver must allocate space to
hold the broadcast address, fill it in with the appropriate value, and set
\fBgldm_broadcast_addr\fR to point at it. For Ethernet, Token Ring, and FDDI,
the broadcast address is normally 0xFF-FF-FF-FF-FF-FF.
.RE

.sp
.ne 2
.na
\fB\fBgldm_vendor_addr\fR\fR
.ad
.RS 24n
Pointer to an array of bytes of length \fBgldm_addrlen\fR containing the
vendor-provided network physical address of the device. The driver must
allocate space to hold the address, fill it in with information read from the
device, and set \fBgldm_vendor_addr\fR to point at it.
.RE

.sp
.ne 2
.na
\fB\fBgldm_ppa\fR\fR
.ad
.RS 24n
The Physical Point of Attachment (PPA) number for this instance of the device.
Normally this should be set to the instance number, returned from
\fBddi_get_instance\fR(9F).
.RE

.sp
.ne 2
.na
\fB\fBgldm_devinfo\fR\fR
.ad
.RS 24n
Pointer to the \fBdev_info\fR node for this device.
.RE

.sp
.ne 2
.na
\fB\fBgldm_cookie\fR\fR
.ad
.RS 24n
The interrupt block cookie returned by \fBddi_get_iblock_cookie\fR(9F),
\fBddi_add_intr\fR(9F), \fBddi_get_soft_iblock_cookie\fR(9F), or
\fBddi_add_softintr\fR(9F). This must correspond to the device's receive
interrupt, from which \fBgld_recv()\fR is called.
.RE

.sp
.ne 2
.na
\fB\fBgldm_margin\fR\fR
.ad
.RS 24n
Drivers set this value to the amount of data in bytes that the device can
transmit beyond \fBgldm_maxpkt\fR. For example, if an Ethernet device can
handle packets whose payload section is no greater than 1522 bytes and the
\fBgldm_maxpkt\fR is set to 1500 (as is typical for Ethernet), then
\fBgldm_margin\fR is set to 22. The registered \fBgldm_margin\fR value is
reported in acknowledgements of the DLIOCMARGININFO ioctl (see \fBdlpi\fR(4P)).
.RE

.sp
.ne 2
.na
\fB\fBgldm_capabilities\fR\fR
.ad
.RS 24n
Bit-field of device capabilities. If the device is capable of reporting media
link state, the GLD_CAP_LINKSTATE bit should be set.
.RE

.SH SEE ALSO
.BR gld (4D),
.BR dlpi (4P),
.BR attach (9E),
.BR gld (9E),
.BR ddi_add_intr (9F),
.BR gld (9F),
.BR gld_stats (9S)
.sp
.LP
\fIWriting Device Drivers\fR