diff options
author | Randall Spangler <rspangler@chromium.org> | 2012-10-25 12:35:49 -0700 |
---|---|---|
committer | Gerrit <chrome-bot@google.com> | 2012-10-25 14:12:11 -0700 |
commit | d4bd167c33e205cab8e01b22975984c668d083b1 (patch) | |
tree | 162b5735b45a33e8e901e630307a23cf008e672d /include/onewire.h | |
parent | e228692eb2b3828ee39adf5a668e71208478226a (diff) | |
download | chrome-ec-d4bd167c33e205cab8e01b22975984c668d083b1.tar.gz |
Clean up LED and onewire modules
No functional changes.
BUG=chrome-os-partner:15579
BRANCH=none
TEST=powerled red, then powerled green
Change-Id: I595b725c14d94133f7f151d0b92cabe0e0bcf4ca
Signed-off-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://gerrit.chromium.org/gerrit/36577
Reviewed-by: Bill Richardson <wfrichar@chromium.org>
Diffstat (limited to 'include/onewire.h')
-rw-r--r-- | include/onewire.h | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/include/onewire.h b/include/onewire.h index f28abdd9b4..afa3a2f3d1 100644 --- a/include/onewire.h +++ b/include/onewire.h @@ -5,25 +5,39 @@ /* 1-wire interface for Chrome EC */ -/* Note that 1-wire communication is VERY latency-sensitive. If these +/* + * Note that 1-wire communication is VERY latency-sensitive. If these * functions are run at low priority, communication may be garbled. However, * these functions are also slow enough (~1ms per call) that it's really not * desirable to put them at high priority. So make sure you check the * confirmation code from the slave for any communication, and retry a few - * times in case of failure. */ + * times in case of failure. + */ #ifndef __CROS_EC_ONEWIRE_H #define __CROS_EC_ONEWIRE_H #include "common.h" -/* Reset the 1-wire bus. Returns error if presence detect fails. */ +/** + * Reset the 1-wire bus. + * + * @return EC_SUCCESS, or non-zero if presence detect fails. + */ int onewire_reset(void); -/* Read a byte from the 1-wire bus. Returns the byte. */ +/** + * Read a byte from the 1-wire bus. + * + * @return The byte value read. + */ int onewire_read(void); -/* Write a byte to the 1-wire bus. */ +/** + * Write a byte to the 1-wire bus. + * + * @param data Byte to write + */ void onewire_write(int data); #endif /* __CROS_EC_ONEWIRE_H */ |