Changeset View
Changeset View
Standalone View
Standalone View
sys/dev/ow/README.txt
- This file was added.
Quick Design Document for 1-wire bus | |||||
In new bus terms, 1-wire devices are attached to 1-wire buses (ow) | |||||
which are attached to a one wire bridge (owc). | |||||
The implementation follows the terminology used in the Maxim AN927 | |||||
Application note which defines the 1-wire bus as implemented for the | |||||
wblock: Typo:
s/termonology/terminology/ | |||||
iButton product. This is considered to be the canonical definition of | |||||
the 1-wire bus. This means that the 1-wire bridge will implement the | |||||
owll(9) interface. ow is one wire. ll is for Link Level to mirror the ISO | |||||
stack terminology used by AN927. The 1-wire bus is implemented in the ow(4) | |||||
device, which implements the own(9) interface (n for network, the layer | |||||
Done Inline ActionsDifferent terms used in this paragraph should be consistent: "one wire", "One wire", "1-wire", "1wire". I think the vendor uses "1-wire", but not sure. wblock: Different terms used in this paragraph should be consistent: "one wire", "One wire", "1-wire"… | |||||
Not Done Inline ActionsMissing a "the": wblock: Missing a "the":
s/in ow/in the ow/ | |||||
described in the AN927). The presentation layer and above is the | |||||
Done Inline Actionss/in ow/in the ow/ wblock: s/in ow/in the ow/ | |||||
Not Done Inline ActionsMaybe use own(4) to make this not seem to be the word "own". wblock: Maybe use own(4) to make this not seem to be the word "own". | |||||
responsibility of the client device drivers to implement. | |||||
Not Done Inline Actions"to implement" is not needed. wblock: "to implement" is not needed.
responsibility of the client device drivers. | |||||
Client drivers may only call the own(9) interface. The ow(4) driver | |||||
calls the owll(9) interface and implements the own(9). | |||||
Done Inline ActionsStrictly speaking, this is not bound by the guideline to avoid contractions, but it would not hurt. That guideline is meant to make it simpler for non-native English speakers. wblock: Strictly speaking, this is not bound by the guideline to avoid contractions, but it would not… | |||||
Not Done Inline ActionsAs above, own(4) rather than just "own". (It is easy to read this as a type saying "their own". wblock: As above, own(4) rather than just "own". (It is easy to read this as a type saying "their own". | |||||
Done Inline ActionsTypo: wblock: Typo:
s/implementaitons/implementations/ | |||||
Not Done Inline Actionss/the own/own/ But other than that, nice! wblock: s/the own/own/
But other than that, nice! |
Typo:
s/termonology/terminology/