diff options
author | Mauro Carvalho Chehab <mchehab+samsung@kernel.org> | 2019-07-31 23:08:53 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2019-07-31 23:16:17 +0300 |
commit | e9bb627561535dd584b43a8c0afe93a67bc6a2c5 (patch) | |
tree | ca91d46418c232f56b7f36010d6fe4317eb9d2ad /Documentation/w1/masters/omap-hdq | |
parent | f139291c713069b5fa826ff509190efb5df83860 (diff) | |
download | linux-e9bb627561535dd584b43a8c0afe93a67bc6a2c5.tar.xz |
docs: w1: convert to ReST and add to the kAPI group of docs
The 1wire documentation was written with w1 developers in
mind, so, it makes sense to add it together with the driver-api
set.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/w1/masters/omap-hdq')
-rw-r--r-- | Documentation/w1/masters/omap-hdq | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/Documentation/w1/masters/omap-hdq b/Documentation/w1/masters/omap-hdq deleted file mode 100644 index 234522709a5f..000000000000 --- a/Documentation/w1/masters/omap-hdq +++ /dev/null @@ -1,52 +0,0 @@ -Kernel driver for omap HDQ/1-wire module. -======================================== - -Supported chips: -================ - HDQ/1-wire controller on the TI OMAP 2430/3430 platforms. - -A useful link about HDQ basics: -=============================== -http://focus.ti.com/lit/an/slua408a/slua408a.pdf - -Description: -============ -The HDQ/1-Wire module of TI OMAP2430/3430 platforms implement the hardware -protocol of the master functions of the Benchmark HDQ and the Dallas -Semiconductor 1-Wire protocols. These protocols use a single wire for -communication between the master (HDQ/1-Wire controller) and the slave -(HDQ/1-Wire external compliant device). - -A typical application of the HDQ/1-Wire module is the communication with battery -monitor (gas gauge) integrated circuits. - -The controller supports operation in both HDQ and 1-wire mode. The essential -difference between the HDQ and 1-wire mode is how the slave device responds to -initialization pulse.In HDQ mode, the firmware does not require the host to -create an initialization pulse to the slave.However, the slave can be reset by -using an initialization pulse (also referred to as a break pulse).The slave -does not respond with a presence pulse as it does in the 1-Wire protocol. - -Remarks: -======== -The driver (drivers/w1/masters/omap_hdq.c) supports the HDQ mode of the -controller. In this mode, as we can not read the ID which obeys the W1 -spec(family:id:crc), a module parameter can be passed to the driver which will -be used to calculate the CRC and pass back an appropriate slave ID to the W1 -core. - -By default the master driver and the BQ slave i/f -driver(drivers/w1/slaves/w1_bq27000.c) sets the ID to 1. -Please note to load both the modules with a different ID if required, but note -that the ID used should be same for both master and slave driver loading. - -e.g: -insmod omap_hdq.ko W1_ID=2 -inamod w1_bq27000.ko F_ID=2 - -The driver also supports 1-wire mode. In this mode, there is no need to -pass slave ID as parameter. The driver will auto-detect slaves connected -to the bus using SEARCH_ROM procedure. 1-wire mode can be selected by -setting "ti,mode" property to "1w" in DT (see -Documentation/devicetree/bindings/w1/omap-hdq.txt for more details). -By default driver is in HDQ mode. |