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 2024 Oxide Computer Company 13.\" 14.Dd September 14, 2024 15.Dt LIBJEDEC_TEMP_RANGE 3JEDEC 16.Os 17.Sh NAME 18.Nm libjedec_temp_range 19.Nd look up JEDEC temperature ranges 20.Sh LIBRARY 21.Lb libjedec 22.Sh SYNOPSIS 23.In libjedec.h 24.Ft boolean_t 25.Fo libjedec_temp_range 26.Fa "libjedec_temp_range_t range" 27.Fa "int32_t *min" 28.Fa "int32_t *max" 29.Fc 30.Sh DESCRIPTION 31The 32.Fn libjedec_temp_range 33function is used to translate a known JEDEC temperature range defined in 34JESD402-1B to the corresponding minimum and maximum temperature for the 35range. 36The temperature range to look for is defined in 37.Fa range 38and if found, both 39.Fa min 40and 41.Fa max 42are updated with the corresponding minimum and maximum temperature 43values in degrees Celsius. 44Both 45.Fa min 46and 47.Fa max 48must be valid pointers and may not be 49.Dv NULL . 50.Pp 51There are four distinct groups of temperature ranges defined: 52.Bl -tag -width Ds 53.It Operating Case Temperature 54This is the temperature of a device's external casing, while it is 55operating. 56For example, for an SSD the case temperature would be the temperature 57of its external enclosure and not the temperature of any interior ASIC, 58circuit board, or storage material. 59Similarly, for a CPU 60.Pq or other ASIC , 61this represents the temperature on the exterior of the CPU such as where 62a heatsink is making contact. 63.It Operating Ambient Temperature 64This is the temperature of the surrounding environment that a device is 65operating in. 66Generally this is a measure of air temperature. 67.It Operating Junction Temperature 68This is the temperature of a device's internal semiconductors. 69.It Storage Temperature 70This is the equivalent of the case temperature; however, it is used when 71the device is not operating and is powered-off. 72.El 73.Sh RETURN VALUES 74Upon successful completion, the 75.Fn libjedec_temp_range 76function returns 77.Dv B_TRUE 78and 79.Fa min 80and 81.Fa max 82are updated with the corresponding ranges. 83Otherwise 84.Dv B_FALSE 85is returned and 86.Fa min 87and 88.Fa max 89are not updated. 90.Sh INTERFACE STABILITY 91.Sy Uncommitted 92.Sh MT-LEVEL 93.Sy MT-Safe 94.Sh SEE ALSO 95.Xr libjedec 3LIB 96.Pp 97.Rs 98.%Q JEDEC Solid State Technology Association 99.%T Temperature Range and Measurement Standards for Components and Modules 100.%N JESD402-1B 101.%D September 2024 102.Re 103