Skip to content

Commit

Permalink
w1: add missing DS2413 documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Mariusz Bialonczyk <manio@skyboo.net>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
  • Loading branch information
Mariusz Bialonczyk authored and Greg Kroah-Hartman committed Mar 17, 2017
1 parent c2a49fe commit a9ee205
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
2 changes: 2 additions & 0 deletions Documentation/w1/slaves/00-INDEX
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
- This file
w1_therm
- The Maxim/Dallas Semiconductor ds18*20 temperature sensor.
w1_ds2413
- The Maxim/Dallas Semiconductor ds2413 dual channel addressable switch.
w1_ds2423
- The Maxim/Dallas Semiconductor ds2423 counter device.
w1_ds28e04
Expand Down
50 changes: 50 additions & 0 deletions Documentation/w1/slaves/w1_ds2413
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Kernel driver w1_ds2413
=======================

Supported chips:
* Maxim DS2413 1-Wire Dual Channel Addressable Switch

supported family codes:
W1_FAMILY_DS2413 0x3A

Author: Mariusz Bialonczyk <manio@skyboo.net>

Description
-----------

The DS2413 chip has two open-drain outputs (PIO A and PIO B).
Support is provided through the sysfs files "output" and "state".

Reading state
-------------
The "state" file provides one-byte value which is in the same format as for
the chip PIO_ACCESS_READ command (refer the datasheet for details):

Bit 0: PIOA Pin State
Bit 1: PIOA Output Latch State
Bit 2: PIOB Pin State
Bit 3: PIOB Output Latch State
Bit 4-7: Complement of Bit 3 to Bit 0 (verified by the kernel module)

This file is readonly.

Writing output
--------------
You can set the PIO pins using the "output" file.
It is writable, you can write one-byte value to this sysfs file.
Similarly the byte format is the same as for the PIO_ACCESS_WRITE command:

Bit 0: PIOA
Bit 1: PIOB
Bit 2-7: No matter (driver will set it to "1"s)


The chip has some kind of basic protection against transmission errors.
When reading the state, there is a four complement bits.
The driver is checking this complement, and when it is wrong then it is
returning I/O error.

When writing output, the master must repeat the PIO Output Data byte in
its inverted form and it is waiting for a confirmation.
If the write is unsuccessful for three times, the write also returns
I/O error.

0 comments on commit a9ee205

Please sign in to comment.