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 2019 Joyent, Inc. 13.\" 14.Dd Apr 30, 2019 15.Dt DDI_UFM_IMAGE 9F 16.Os 17.Sh NAME 18.Nm ddi_ufm_image_set_desc , 19.Nm ddi_ufm_image_set_misc , 20.Nm ddi_ufm_image_set_nslots 21.Nd UFM image property routines 22.Sh SYNOPSIS 23.In sys/ddi_ufm.h 24.Ft void 25.Fo ddi_ufm_image_set_desc 26.Fa "ddi_ufm_image_t *uip" 27.Fa "const char *description" 28.Fc 29.Ft void 30.Fo ddi_ufm_image_set_misc 31.Fa "ddi_ufm_image_t *uip" 32.Fa "nvlist_t *nvl" 33.Fc 34.Ft void 35.Fo ddi_ufm_image_set_nslots 36.Fa "ddi_ufm_image_t *uip" 37.Fa "uint_t nslots" 38.Fc 39.Sh INTERFACE LEVEL 40.Sy Evolving - 41This interface is evolving still in illumos. 42API and ABI stability is not guaranteed. 43.Sh PARAMETERS 44.Bl -tag -width Fa 45.It Fa uip 46A pointer to a UFM image that was passed to the driver in its 47.Xr ddi_ufm_op_fill_image 9E 48entry point. 49.It Fa description 50A human-readable description of the firmware image. 51.It Fa nvl 52An nvlist_t with ancillary, device-specific data. 53.It Fa nslots 54The number of firmware slots supported by this firmare image. 55.El 56.Sh DESCRIPTION 57The 58.Fn ddi_ufm_image_set_desc , 59.Fn ddi_ufm_image_set_misc 60and 61.Fn ddi_ufm_image_set_nslots 62functions are used by device drivers to set information about a firmware 63image on the image structure 64.Fa uip 65as a part of implementing their 66.Xr ddi_ufm_op_fill_image 9E 67entry point. 68For more information on images and the use of these functions, see the 69description of the 70.Fn ddi_ufm_op_fill_image 71function in 72.Xr ddi_ufm 9E . 73.Pp 74The 75.Fn ddi_ufm_image_set_desc 76function sets the description of the firmware image. 77This description is intended for administrators and should convey the intended 78use of the image. 79.Pp 80The 81.Fn ddi_ufm_image_set_misc 82function is used by drivers to set ancillary key-value data that may be 83useful to a consumer. 84The driver should create an nvlist for this purpose with 85.Xr nvlist_alloc 9F 86Once the driver passes the nvlist to the 87.Fn ddi_ufm_image_set_misc 88function, then the driver must not manipulate or free the nvlist at all. 89It is the property of the UFM subsystem. 90.Pp 91The 92.Fn ddi_ufm_image_set_nslots 93function should be called to indicate the number of firmware slots supported 94by this firmware image. 95.Sh CONTEXT 96These functions should only be called in the context of the 97.Xr ddi_ufm_op_fill_image 9E 98entry point. 99.Sh SEE ALSO 100.Xr ddi_ufm 9E , 101.Xr ddi_ufm_op_fill_image 9E , 102.Xr nvlist_alloc 9F 103