summaryrefslogtreecommitdiff
path: root/libhw/rp2040_include
diff options
context:
space:
mode:
authorLuke T. Shumaker <lukeshu@lukeshu.com>2025-02-21 12:23:09 -0700
committerLuke T. Shumaker <lukeshu@lukeshu.com>2025-02-23 10:41:43 -0700
commita1883e93c1094ed34c21e018d34993e2a9e80506 (patch)
tree2e76cbb95a127ad3fb517dfb94d1cf1034150a89 /libhw/rp2040_include
parent8f7feb7852ec7cb15c7f51de78f2c474d8807bd7 (diff)
Complete TODO comments and documentation
Diffstat (limited to 'libhw/rp2040_include')
-rw-r--r--libhw/rp2040_include/libhw/w5500.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/libhw/rp2040_include/libhw/w5500.h b/libhw/rp2040_include/libhw/w5500.h
index ab9f50e..98e54ec 100644
--- a/libhw/rp2040_include/libhw/w5500.h
+++ b/libhw/rp2040_include/libhw/w5500.h
@@ -86,12 +86,18 @@ void _w5500_init(struct w5500 *self,
struct net_eth_addr addr);
/**
- * TODO.
+ * Perform a hard reset on the chip (pull the reset line low).
+ *
+ * If you have any in-use sockets when you call this, you're going to
+ * have a bad time.
*/
void w5500_hard_reset(struct w5500 *self);
/**
- * TODO.
+ * Perform a soft reset on the chip (send the RST command).
+ *
+ * If you have any in-use sockets when you call this, you're going to
+ * have a bad time.
*/
void w5500_soft_reset(struct w5500 *self);