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