Page MenuHomeFreeBSD
Differential D8174

jedec_ts: a driver for temperature sensors on memory modules
ClosedPublic
Actions

Authored by avg on Oct 7 2016, 8:13 AM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Apr 3, 1:47 AM
Unknown Object (File)
Fri, Mar 14, 3:28 PM
Unknown Object (File)
Feb 9 2025, 6:35 AM
Unknown Object (File)
Feb 8 2025, 7:07 AM
Unknown Object (File)
Jan 22 2025, 3:56 AM
Unknown Object (File)
Jan 10 2025, 11:24 AM
Unknown Object (File)
Jan 8 2025, 7:05 AM
Unknown Object (File)
Jan 5 2025, 3:36 PM
View All Files
Subscribers
wblock

Details

Reviewers
jhb
wblock
imp
Group Reviewers
manpages
Commits
rS307768: jedec_ts: a driver for thermal sensors on memory modules
Summary

The driver currently supports chips that are fully compliant with the
JEDEC SPD / EEPROM / TS standard (JEDEC Standard 21-C,
TSE2002 Specification, frequenlty referred to as JEDEC JC 42.4).

Additionally some chips from STMicroelectronics are supported as well.
They are compliant except for their Device ID pattern.

Test Plan

Tested on hardware that I have access to:
KVR16E11S8/4 memory modules with STTS424E02 chip (compines a temperature
sensor and an SPD EEPROM).
Example:
dev.jedec_ts.0.temp: 39.2500C

Diff Detail

Event Timeline

avg updated this revision to Diff 21137.Oct 7 2016, 8:13 AM
avg retitled this revision from to jedec_ts: a driver for temperature sensors on memory modules.
avg updated this object.
avg edited the test plan for this revision. (Show Details)
avg added reviewers: imp, jhb.
Herald added a reviewer: manpages. · View Herald TranscriptOct 7 2016, 8:13 AM
avg added a parent revision: D8173: smbus: allow child devices to be added via hints.Oct 7 2016, 8:14 AM
imp added inline comments.Oct 8 2016, 4:24 AM
sys/dev/jedec_ts/jedec_ts.c
104

It would be safer to put all this in the attach routine.
Most of the I2C drivers just assume the probe is good.
There are a few that write to the chip during the probe.

avg added inline comments.Oct 10 2016, 2:08 PM
sys/dev/jedec_ts/jedec_ts.c
104

Is this to avoid fiddling with the hardware in case that a more specific driver wins the device during probing?
I'll make the change.

avg updated this revision to Diff 21293.Oct 12 2016, 7:03 AM
avg edited edge metadata.

jedec_ts: move hardware probing to the attach routine

This is done, so that another, more specific driver could claim
the device before this driver has a chance to mess up the hardware.

Herald edited edge metadata. · View Herald TranscriptOct 12 2016, 7:03 AM
avg marked 2 inline comments as done.Oct 12 2016, 7:30 AM
avg updated this revision to Diff 21342.Oct 13 2016, 6:40 AM
avg edited edge metadata.
  • actually allow to be compiled into the kernel
  • add to NOTES / LINT
  • some clean-ups in the manual page
Herald edited edge metadata. · View Herald TranscriptOct 13 2016, 6:40 AM
wblock added a subscriber: wblock.Oct 14 2016, 3:09 PM
wblock added inline comments.
share/man/man4/jedec_ts.4
79

Not sure if .Va should be included in the parameter as it is invisible, but at worst it just gives an extra three spaces of indent.

85

Needs a comma:

.Xr device.hints 5 ,
99

Generally, numbers less than ten should be spelled out.

100

As above, s/8/eight/.

avg updated this revision to Diff 21415.Oct 15 2016, 9:25 AM
avg edited edge metadata.

man page fixes suggested by wblock

Herald edited edge metadata. · View Herald TranscriptOct 15 2016, 9:25 AM
avg marked 4 inline comments as done.Oct 15 2016, 9:26 AM
wblock accepted this revision.Oct 16 2016, 5:38 PM
wblock added a reviewer: wblock.

Man page looks good, but please test with mandoc -Tlint and igor -Rbefore commit. Thanks!

This revision is now accepted and ready to land.Oct 16 2016, 5:38 PM
avg updated this revision to Diff 21438.Oct 17 2016, 7:39 AM
avg edited edge metadata.

add jedec_ts to modules/i2c/Makefile

This revision now requires review to proceed.Oct 17 2016, 7:39 AM
avg added a comment.Oct 17 2016, 7:40 AM

If there are no objections or requests for changes, I would like to commit this driver sooner rather than later.

Closed by commit rS307768: jedec_ts: a driver for thermal sensors on memory modules (authored by avg). · Explain WhyOct 22 2016, 8:01 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
share/
man/
man4/
130 lines
sys/
conf/
5 lines
1 line
dev/
jedec_ts/
179 lines
modules/
i2c/
jedec_ts/
7 lines

Diff 21342

View Options

share/man/man4/jedec_ts.4

  • This file was added.
PropertyOld ValueNew Value
svn:eol-stylenullnative
\ No newline at end of property
svn:keywordsnullFreeBSD=%H
\ No newline at end of property
\ No newline at end of property
svn:mime-typenulltext/plain
\ No newline at end of property
.\"
.\" Copyright (c) 2016 Andriy Gapon <avg@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd October 13, 2016
.Dt JEDEC_TS 4
.Os
.Sh NAME
.Nm jedec_ts
.Nd driver for temperature sensors on memory modules
.Sh SYNOPSIS
.Bd -ragged -offset indent
.Cd "device jedec_ts"
.Cd "device smbus"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
jedec_ts_load="YES"
.Ed
.Pp
In
.Pa /boot/device.hints :
.Bd -literal -offset indent
.Cd hint.jedec_ts.0.at="smbus0"
.Cd hint.jedec_ts.0.addr="0x30"
.Cd hint.jedec_ts.1.at="smbus0"
.Cd hint.jedec_ts.1.addr="0x32"
.Cd hint.jedec_ts.2.at="smbus0"
.Cd hint.jedec_ts.2.addr="0x34"
.Cd hint.jedec_ts.3.at="smbus0"
.Cd hint.jedec_ts.3.addr="0x36"
.Cd hint.jedec_ts.4.at="smbus0"
.Cd hint.jedec_ts.4.addr="0x38"
.Cd hint.jedec_ts.5.at="smbus0"
.Cd hint.jedec_ts.5.addr="0x3A"
.Cd hint.jedec_ts.6.at="smbus0"
.Cd hint.jedec_ts.6.addr="0x3C"
.Cd hint.jedec_ts.7.at="smbus0"
.Cd hint.jedec_ts.7.addr="0x3E"
.Ed
.Sh DESCRIPTION
The
.Nm
driver provides access to sensor data over the
.Xr smbus 4 .
The driver supports temperature sensors on memory modules that conform
to JEDEC Standard 21-C, TSE2002 Specification.
.Pp
The access to
.Nm
data is made via the
.Xr sysctl 8
interface:
.Bl -tag -width ".Va dev.jedec_ts.%d.temp"
wblockUnsubmitted
Done
Inline Actions

Not sure if .Va should be included in the parameter as it is invisible, but at worst it just gives an extra three spaces of indent.

wblock: Not sure if `.Va` should be included in the parameter as it is invisible, but at worst it just…
.It Va dev.jedec_ts.%d.temp
read-only value of the current temperature read by the sensor.
.El
.Pp
On a system using
.Xr device.hints 5
wblockUnsubmitted
Done
Inline Actions

Needs a comma:

.Xr device.hints 5 ,
wblock: Needs a comma: ```.Xr device.hints 5 ,```
these values are configurable for
.Nm :
.Bl -tag -width ".Va hint.jedec_ts.%d.addr"
.It Va hint.jedec_ts.%d.at
target
.Xr smbus 4 .
.It Va hint.jedec_ts.%d.addr
.Nm
SMBus address on the
.Xr smbus 4 .
.El
.Pp
.Nm
temperature sensors can be wired to 8 different addresses,
wblockUnsubmitted
Done
Inline Actions

Generally, numbers less than ten should be spelled out.

wblock: Generally, numbers less than ten should be spelled out.
allowing up to 8 sensors on the same
wblockUnsubmitted
Done
Inline Actions

As above, s/8/eight/.

wblock: As above, s/8/eight/.
.Xr smbus 4 .
.Pp
If the sensors are on an I2C bus behind an
.Xr iicbus 4
controller, then the
.Xr iicsmb 4
bridge driver can be used to attach the
.Xr smbus 4 .
.Sh EXAMPLES
.Ss Sensor read out for two memory modules:
.Bd -literal
dev.jedec_ts.0.temp: 40.2500C
dev.jedec_ts.1.temp: 40.7500C
.Ed
.Sh SEE ALSO
.Xr iicbus 4 ,
.Xr iicsmb 4 ,
.Xr smbus 4 ,
.Xr sysctl 8
.Sh HISTORY
The
.Nm
driver first appeared in
.Fx 12.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
driver and this manual page were written by
.An Andriy Gapon Aq Mt avg@FreeBSD.org .
View Options

sys/conf/NOTES

Show First 20 Lines • Show All 2,518 Lines • ▼ Show 20 Lines
device amdpm device amdpm
device amdsmb device amdsmb
device nfpm device nfpm
device nfsmb device nfsmb
device ismt device ismt
device smb device smb
# SMBus peripheral devices
# #
# jedec_ts Temperature Sensor compliant with JEDEC Standard 21-C
#
device jedec_ts
# I2C Bus # I2C Bus
# #
# Philips i2c bus support is provided by the `iicbus' device. # Philips i2c bus support is provided by the `iicbus' device.
# #
# Supported devices: # Supported devices:
# ic i2c network interface # ic i2c network interface
# iic i2c standard io # iic i2c standard io
# iicsmb i2c to smb bridge. Allow i2c i/o with smb commands. # iicsmb i2c to smb bridge. Allow i2c i/o with smb commands.
▲ Show 20 Lines • Show All 526 Lines • Show Last 20 Lines
View Options

sys/conf/files

Loading...
View Options

sys/dev/jedec_ts/

  • This directory was added.
View Options

sys/dev/jedec_ts/jedec_ts.c

Loading...
View Options

sys/modules/i2c/jedec_ts/

Loading...
View Options

sys/modules/i2c/jedec_ts/Makefile

Loading...