xref: /titanic_44/usr/src/man/man9f/mac_transceiver_info.9f (revision 48a4016cae8aa2b8b3d8b258eb22e0c781912bed)
1*48a4016cSRobert Mustacchi.\"
2*48a4016cSRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3*48a4016cSRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*48a4016cSRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5*48a4016cSRobert Mustacchi.\" 1.0 of the CDDL.
6*48a4016cSRobert Mustacchi.\"
7*48a4016cSRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8*48a4016cSRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9*48a4016cSRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10*48a4016cSRobert Mustacchi.\"
11*48a4016cSRobert Mustacchi.\"
12*48a4016cSRobert Mustacchi.\" Copyright (c) 2017, Joyent, Inc.
13*48a4016cSRobert Mustacchi.\"
14*48a4016cSRobert Mustacchi.Dd Feb 21, 2017
15*48a4016cSRobert Mustacchi.Dt MAC_TRANSCEIVER_INFO 9F
16*48a4016cSRobert Mustacchi.Os
17*48a4016cSRobert Mustacchi.Sh NAME
18*48a4016cSRobert Mustacchi.Nm mac_transceiver_info ,
19*48a4016cSRobert Mustacchi.Nm mac_transceiver_info_set_present ,
20*48a4016cSRobert Mustacchi.Nm mac_transceiver_info_set_usable
21*48a4016cSRobert Mustacchi.Nd set MAC transceiver property information
22*48a4016cSRobert Mustacchi.Sh SYNOPSIS
23*48a4016cSRobert Mustacchi.In sys/mac_provider.h
24*48a4016cSRobert Mustacchi.Ft void
25*48a4016cSRobert Mustacchi.Fo mac_transceiver_info_set_present
26*48a4016cSRobert Mustacchi.Fa "mac_transceiver_info_t *infop"
27*48a4016cSRobert Mustacchi.Fa "boolean_t present"
28*48a4016cSRobert Mustacchi.Fc
29*48a4016cSRobert Mustacchi.Ft void
30*48a4016cSRobert Mustacchi.Fo mac_transceiver_info_set_usable
31*48a4016cSRobert Mustacchi.Fa "mac_transceiver_info_t *infop"
32*48a4016cSRobert Mustacchi.Fa "boolean_t usable"
33*48a4016cSRobert Mustacchi.Fc
34*48a4016cSRobert Mustacchi.Sh INTERFACE LEVEL
35*48a4016cSRobert Mustacchi.Sy Volatile -
36*48a4016cSRobert MustacchiThis interface is still evolving in illumos.
37*48a4016cSRobert MustacchiAPI and ABI stability is
38*48a4016cSRobert Mustacchinot guaranteed.
39*48a4016cSRobert Mustacchi.Sh PARAMETERS
40*48a4016cSRobert Mustacchi.Bl -tag -width Fa
41*48a4016cSRobert Mustacchi.It Fa infop
42*48a4016cSRobert MustacchiA pointer to an opaque structure obtained as an argument to the
43*48a4016cSRobert Mustacchi.Xr mct_info 9E
44*48a4016cSRobert Mustacchientry point.
45*48a4016cSRobert Mustacchi.It Fa present
46*48a4016cSRobert MustacchiA boolean that indicates whether the transceiver is present.
47*48a4016cSRobert Mustacchi.It Fa usable
48*48a4016cSRobert MustacchiA boolean that indicates whether the transceiver is usable.
49*48a4016cSRobert Mustacchi.El
50*48a4016cSRobert Mustacchi.Sh DESCRIPTION
51*48a4016cSRobert MustacchiThe
52*48a4016cSRobert Mustacchi.Fn mac_transceiver_set_present
53*48a4016cSRobert Mustacchiand
54*48a4016cSRobert Mustacchi.Fn mac_transceiver_set_usable
55*48a4016cSRobert Mustacchifunctions are used to set information about a transceiver as part of the
56*48a4016cSRobert Mustacchi.Xr mct_info 9E
57*48a4016cSRobert Mustacchientry point to obtain information about a MAC transceiver.
58*48a4016cSRobert MustacchiFor more information and background, see the
59*48a4016cSRobert Mustacchi.Sy Transceiver Information Functions
60*48a4016cSRobert Mustacchisection of
61*48a4016cSRobert Mustacchi.Xr mac_capab_transceiver 9E .
62*48a4016cSRobert Mustacchi.Pp
63*48a4016cSRobert MustacchiThe
64*48a4016cSRobert Mustacchi.Fn mct_transceiver_set_present
65*48a4016cSRobert Mustacchifunction sets whether or not the transceiver is present and plugged into
66*48a4016cSRobert Mustacchithe system.
67*48a4016cSRobert MustacchiIf the transceiver is not plugged in, then the function
68*48a4016cSRobert Mustacchishould be called with
69*48a4016cSRobert Mustacchi.Fa present set to
70*48a4016cSRobert Mustacchi.Dv B_FALSE ,
71*48a4016cSRobert Mustacchiotehrwise it should use
72*48a4016cSRobert Mustacchi.Dv B_TRUE .
73*48a4016cSRobert Mustacchi.Pp
74*48a4016cSRobert MustacchiThe
75*48a4016cSRobert Mustacchi.Fn mct_transceiver_set_usable
76*48a4016cSRobert Mustacchifunction determines whether or not the device can use the transceiver.
77*48a4016cSRobert MustacchiIf the device cannot use the transceiver, then it should call the
78*48a4016cSRobert Mustacchifunction with
79*48a4016cSRobert Mustacchi.Fa usable
80*48a4016cSRobert Mustacchiset to
81*48a4016cSRobert Mustacchi.Dv B_FALSE .
82*48a4016cSRobert MustacchiOtherwise, it should use
83*48a4016cSRobert Mustacchi.Dv B_TRUE .
84*48a4016cSRobert MustacchiIf the transceiver is not present, then this function should not be
85*48a4016cSRobert Mustacchicalled.
86*48a4016cSRobert Mustacchi.Sh CONTEXT
87*48a4016cSRobert MustacchiThese functions should be called in response to handling the
88*48a4016cSRobert Mustacchi.Fn mct_info 9E
89*48a4016cSRobert Mustacchientry point for transceivers in
90*48a4016cSRobert Mustacchi.Sy kernel
91*48a4016cSRobert Mustacchicontext.
92*48a4016cSRobert Mustacchi.Sh SEE ALSO
93*48a4016cSRobert Mustacchi.Xr mac 9E ,
94*48a4016cSRobert Mustacchi.Xr mac_capab_transceiver 9E ,
95*48a4016cSRobert Mustacchi.Xr mct_info 9E
96