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