xref: /illumos-gate/usr/src/man/man3jedec/libjedec_temp_range.3jedec (revision f7379be0e8a103179bb13516195101c745bd6a30)
1b3783300SRobert Mustacchi.\"
2b3783300SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3b3783300SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4b3783300SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5b3783300SRobert Mustacchi.\" 1.0 of the CDDL.
6b3783300SRobert Mustacchi.\"
7b3783300SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8b3783300SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9b3783300SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10b3783300SRobert Mustacchi.\"
11b3783300SRobert Mustacchi.\"
12*f7379be0SRobert Mustacchi.\" Copyright 2024 Oxide Computer Company
13b3783300SRobert Mustacchi.\"
14*f7379be0SRobert Mustacchi.Dd September 14, 2024
15b3783300SRobert Mustacchi.Dt LIBJEDEC_TEMP_RANGE 3JEDEC
16b3783300SRobert Mustacchi.Os
17b3783300SRobert Mustacchi.Sh NAME
18b3783300SRobert Mustacchi.Nm libjedec_temp_range
19b3783300SRobert Mustacchi.Nd look up JEDEC temperature ranges
20b3783300SRobert Mustacchi.Sh LIBRARY
21b3783300SRobert Mustacchi.Lb libjedec
22b3783300SRobert Mustacchi.Sh SYNOPSIS
23b3783300SRobert Mustacchi.In libjedec.h
24b3783300SRobert Mustacchi.Ft boolean_t
25b3783300SRobert Mustacchi.Fo libjedec_temp_range
26b3783300SRobert Mustacchi.Fa "libjedec_temp_range_t range"
27b3783300SRobert Mustacchi.Fa "int32_t *min"
28b3783300SRobert Mustacchi.Fa "int32_t *max"
29b3783300SRobert Mustacchi.Fc
30b3783300SRobert Mustacchi.Sh DESCRIPTION
31b3783300SRobert MustacchiThe
32b3783300SRobert Mustacchi.Fn libjedec_temp_range
33b3783300SRobert Mustacchifunction is used to translate a known JEDEC temperature range defined in
34*f7379be0SRobert MustacchiJESD402-1B to the corresponding minimum and maximum temperature for the
35b3783300SRobert Mustacchirange.
36b3783300SRobert MustacchiThe temperature range to look for is defined in
37b3783300SRobert Mustacchi.Fa range
38b3783300SRobert Mustacchiand if found, both
39b3783300SRobert Mustacchi.Fa min
40b3783300SRobert Mustacchiand
41b3783300SRobert Mustacchi.Fa max
42b3783300SRobert Mustacchiare updated with the corresponding minimum and maximum temperature
43b3783300SRobert Mustacchivalues in degrees Celsius.
44b3783300SRobert MustacchiBoth
45b3783300SRobert Mustacchi.Fa min
46b3783300SRobert Mustacchiand
47b3783300SRobert Mustacchi.Fa max
48b3783300SRobert Mustacchimust be valid pointers and may not be
49b3783300SRobert Mustacchi.Dv NULL .
50*f7379be0SRobert Mustacchi.Pp
51*f7379be0SRobert MustacchiThere are four distinct groups of temperature ranges defined:
52*f7379be0SRobert Mustacchi.Bl -tag -width Ds
53*f7379be0SRobert Mustacchi.It Operating Case Temperature
54*f7379be0SRobert MustacchiThis is the temperature of a device's external casing, while it is
55*f7379be0SRobert Mustacchioperating.
56*f7379be0SRobert MustacchiFor example, for an SSD the case temperature would be the temperature
57*f7379be0SRobert Mustacchiof its external enclosure and not the temperature of any interior ASIC,
58*f7379be0SRobert Mustacchicircuit board, or storage material.
59*f7379be0SRobert MustacchiSimilarly, for a CPU
60*f7379be0SRobert Mustacchi.Pq or other ASIC ,
61*f7379be0SRobert Mustacchithis represents the temperature on the exterior of the CPU such as where
62*f7379be0SRobert Mustacchia heatsink is making contact.
63*f7379be0SRobert Mustacchi.It Operating Ambient Temperature
64*f7379be0SRobert MustacchiThis is the temperature of the surrounding environment that a device is
65*f7379be0SRobert Mustacchioperating in.
66*f7379be0SRobert MustacchiGenerally this is a measure of air temperature.
67*f7379be0SRobert Mustacchi.It Operating Junction Temperature
68*f7379be0SRobert MustacchiThis is the temperature of a device's internal semiconductors.
69*f7379be0SRobert Mustacchi.It Storage Temperature
70*f7379be0SRobert MustacchiThis is the equivalent of the case temperature; however, it is used when
71*f7379be0SRobert Mustacchithe device is not operating and is powered-off.
72*f7379be0SRobert Mustacchi.El
73b3783300SRobert Mustacchi.Sh RETURN VALUES
74b3783300SRobert MustacchiUpon successful completion, the
75b3783300SRobert Mustacchi.Fn libjedec_temp_range
76b3783300SRobert Mustacchifunction returns
77b3783300SRobert Mustacchi.Dv B_TRUE
78b3783300SRobert Mustacchiand
79b3783300SRobert Mustacchi.Fa min
80b3783300SRobert Mustacchiand
81b3783300SRobert Mustacchi.Fa max
82b3783300SRobert Mustacchiare updated with the corresponding ranges.
83b3783300SRobert MustacchiOtherwise
84b3783300SRobert Mustacchi.Dv B_FALSE
85b3783300SRobert Mustacchiis returned and
86b3783300SRobert Mustacchi.Fa min
87b3783300SRobert Mustacchiand
88b3783300SRobert Mustacchi.Fa max
89b3783300SRobert Mustacchiare not updated.
90b3783300SRobert Mustacchi.Sh INTERFACE STABILITY
91b3783300SRobert Mustacchi.Sy Uncommitted
92b3783300SRobert Mustacchi.Sh MT-LEVEL
93b3783300SRobert Mustacchi.Sy MT-Safe
94b3783300SRobert Mustacchi.Sh SEE ALSO
95b3783300SRobert Mustacchi.Xr libjedec 3LIB
96b3783300SRobert Mustacchi.Pp
97b3783300SRobert Mustacchi.Rs
98b3783300SRobert Mustacchi.%Q JEDEC Solid State Technology Association
99b3783300SRobert Mustacchi.%T Temperature Range and Measurement Standards for Components and Modules
100*f7379be0SRobert Mustacchi.%N JESD402-1B
101*f7379be0SRobert Mustacchi.%D September 2024
102b3783300SRobert Mustacchi.Re
103