Skip to content

Commit ac63314

Browse files
committed
drivers: w1: updates to reflect analog maxim acquisition
Links and the manufacturer name are updated from maxim to analog for the 1-wire subsystem and the related ds18b20 sensor. After the acquisition of Maxim Integrated the documentation of these devices has been moved to the analog.com website. Redirects exist, so they are not broken yet, but we should not rely on that. Signed-off-by: Thomas Stranger <[email protected]>
1 parent c3466b1 commit ac63314

File tree

8 files changed

+21
-21
lines changed

8 files changed

+21
-21
lines changed

doc/hardware/peripherals/w1.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ In Zephyr this API is split into the following layers.
5252
includes a 8-bit `1-Wire Family Code`_ and a 8-bit CRC.
5353
* In order to find slaves on the bus, the standard specifies an search
5454
algorithm which successively detects all slaves on the bus.
55-
This algorithm is described in detail by `Maxim's Applicationnote 187`_.
55+
This algorithm is described in the `1-Wire Search Algorithm Application Note`_.
5656

5757
* Transport layer and Presentation layer functions are not implemented in the
5858
generic 1-Wire driver and therefore must be handled in individual slave drivers.
@@ -91,10 +91,10 @@ Functions that are not directly related to any of the networking layers.
9191

9292

9393
.. _BOOK OF IBUTTON STANDARDS:
94-
https://www.maximintegrated.com/en/design/technical-documents/app-notes/9/937.html
94+
https://www.analog.com/en/resources/technical-articles/book-of-ibuttonreg-standards.html
9595

9696
.. _1-Wire Family Code:
97-
https://www.maximintegrated.com/en/design/technical-documents/app-notes/1/155.html
97+
https://www.analog.com/en/resources/technical-articles/1wire-software-resource-guide-device-description.html
9898

99-
.. _Maxim's Applicationnote 187:
100-
https://www.maximintegrated.com/en/design/technical-documents/app-notes/1/187.html
99+
.. _1-Wire Search Algorithm Application Note:
100+
https://www.analog.com/en/resources/app-notes/1wire-search-algorithm.html

drivers/sensor/maxim/ds18b20/ds18b20.c

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,10 @@
55
*/
66

77
/**
8-
* Driver for DS18B20 1-Wire temperature sensors
9-
* A datasheet is available at:
10-
* https://datasheets.maximintegrated.com/en/ds/DS18B20.pdf
11-
*
12-
* Driver also support the older DS18S20 1-Wire temperature sensors.
13-
* https://www.analog.com/media/en/technical-documentation/data-sheets/ds18b20.pdf
8+
* Driver for DS18B20 and DS18S20 1-Wire temperature sensors
9+
* Datasheets for the compatible sensors are available at:
10+
* - https://www.analog.com/media/en/technical-documentation/data-sheets/ds18b20.pdf
11+
* - https://www.analog.com/media/en/technical-documentation/data-sheets/ds18s20.pdf
1412
*
1513
* Parasite power configuration is not supported by the driver.
1614
*/

drivers/w1/w1_ds2477_85_common.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
*/
66

77
/**
8-
* @brief Common functions for Maxim DS2477,DS2485 1-Wire Masters
8+
* @brief Common functions for Analog Devices DS2477,DS2485 1-Wire Masters
99
*/
1010

1111
#include "w1_ds2477_85_common.h"

drivers/w1/w1_ds2485.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
#define DT_DRV_COMPAT maxim_ds2485
88

99
/**
10-
* @brief Driver for the Maxim ds2485 1-Wire Master
10+
* @brief Driver for the Analog Devices DS2485 1-Wire Master
1111
*/
1212

1313
#include "w1_ds2477_85_common.h"

drivers/w1/w1_net.c

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ LOG_MODULE_REGISTER(w1, CONFIG_W1_LOG_LEVEL);
3131
* W1_SEARCH_LAST_SLAVE, and in case no slave participated in the search,
3232
* the discrepancy is set to W1_SEARCH_NO_SLAVE.
3333
*
34-
* The implementation is similar to suggested in the maxim application note 187.
34+
* The implementation is similar to that suggested in the Maxim Integrated
35+
* application note 187.
36+
* @see https://www.analog.com/media/en/technical-documentation/app-notes/1wire-search-algorithm.pdf
3537
* The master reads the first ROM bit and its complementary value of all slaves.
3638
* Due to physical characteristics, the value received is a
3739
* logical AND of all slaves' 1st bit. Slaves only continue to

drivers/w1/w1_zephyr_gpio.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616
* The driver supports both standard speed and overdrive speed modes.
1717
*
1818
* This driver is heavily based on the w1_zephyr_serial.c driver and the
19-
* technical documentation from Maxim Integrated.
19+
* technical article from Analog Devices.
2020
*
2121
* - w1_zephyr_serial.c: drivers/w1/w1_zephyr_serial.c
22-
* - Maxim Integrated 1-Wire Communication Through Software:
23-
* https://www.analog.com/en/technical-articles/1wire-communication-through-software.html
22+
* - Analog Devices 1-Wire Communication Through Software:
23+
* https://www.analog.com/en/resources/technical-articles/1wire-communication-through-software.html
2424
*/
2525

2626
#include <zephyr/drivers/gpio.h>

drivers/w1/w1_zephyr_serial.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* The driver uses a uart peripheral with a baudrate of 115.2 kBd to send
1414
* and receive data bits and a baurade of 9.6 kBd for slave reset and
1515
* presence detection as suggested for normal speed operating mode in:
16-
* https://www.maximintegrated.com/en/design/technical-documents/tutorials/2/214.html
16+
* https://www.analog.com/en/resources/technical-articles/using-a-uart-to-implement-a-1wire-bus-master.html
1717
* For overdrive speed communication baudrates of 1 MBd and 115.2 kBd
1818
* are used, respectively.
1919
*/

include/zephyr/drivers/w1.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@ struct w1_rom {
435435
/** @brief The 1-Wire family code identifying the slave device type.
436436
*
437437
* An incomplete list of family codes is available at:
438-
* https://www.maximintegrated.com/en/app-notes/index.mvp/id/155
438+
* https://www.analog.com/en/resources/technical-articles/1wire-software-resource-guide-device-description.html
439439
* others are documented in the respective device data sheet.
440440
*/
441441
uint8_t family;
@@ -584,7 +584,7 @@ int w1_write_read(const struct device *dev, const struct w1_slave_config *config
584584
* If a callback is passed, the callback is called for each found slave.
585585
*
586586
* The algorithm mostly follows the suggestions of
587-
* https://pdfserv.maximintegrated.com/en/an/AN187.pdf
587+
* https://www.analog.com/en/resources/app-notes/1wire-search-algorithm.html
588588
*
589589
* Note: Filtering on families is not supported.
590590
*
@@ -695,7 +695,7 @@ static inline uint8_t w1_crc8(const uint8_t *src, size_t len)
695695
* X^16 + X^15 * + X^2 + 1 with the initial value set to 0x0000.
696696
* See also APPLICATION NOTE 27:
697697
* "UNDERSTANDING AND USING CYCLIC REDUNDANCY CHECKS WITH MAXIM 1-WIRE AND IBUTTON PRODUCTS"
698-
* https://www.maximintegrated.com/en/design/technical-documents/app-notes/2/27.html
698+
* https://www.analog.com/en/resources/technical-articles/understanding-and-using-cyclic-redundancy-checks-with-maxim-1wire-and-ibutton-products.html
699699
*
700700
* @param seed Init value for the CRC, it is usually set to 0x0000.
701701
* @param[in] src Input bytes for the computation.

0 commit comments

Comments
 (0)