xref: /illumos-gate/usr/src/man/man3jedec/libjedec_temp_range.3jedec (revision 8119dad84d6416f13557b0ba8e2aaf9064cbcfd3)
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 2023 Oxide Computer Company
13.\"
14.Dd September 21, 2023
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-1A 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.Sh RETURN VALUES
51Upon successful completion, the
52.Fn libjedec_temp_range
53function returns
54.Dv B_TRUE
55and
56.Fa min
57and
58.Fa max
59are updated with the corresponding ranges.
60Otherwise
61.Dv B_FALSE
62is returned and
63.Fa min
64and
65.Fa max
66are not updated.
67.Sh INTERFACE STABILITY
68.Sy Uncommitted
69.Sh MT-LEVEL
70.Sy MT-Safe
71.Sh SEE ALSO
72.Xr libjedec 3LIB
73.Pp
74.Rs
75.%Q JEDEC Solid State Technology Association
76.%T Temperature Range and Measurement Standards for Components and Modules
77.%N JESD402-1A
78.%D March 2022
79.Re
80