Added more plca()

Author: bjackson312006

general/include/lan8670.h

@@ -47,7 +47,7 @@ int lan8670_reset(lan8670_t *lan); // Performs a software reset of the LAN8670 E
  *
  * @param lan Pointer to the lan8670_t instance.
  * @param setting true to enable loopback mode, false to disable it.
- * @return 0 on success, or a non-zero error code from the read/write operations.
+ * @return 0 on success, or a non-zero error code.
  */
 int lan8670_loopback(lan8670_t *lan, bool setting); // Enables or disables loopback mode on the LAN8670.
 
@@ -59,15 +59,15 @@ int lan8670_loopback(lan8670_t *lan, bool setting); // Enables or disables loopb
  *
  * @param lan Pointer to the lan8670_t instance.
  * @param setting true to enable low power mode, false to disable it.
- * @return 0 on success, or a non-zero error code from the read/write operations.
+ * @return 0 on success, or a non-zero error code.
  */
 int lan8670_low_power_mode(lan8670_t *lan, bool setting); // Enables or disables the LAN8670's low power mode.
 
 /**
  * @brief Electrically isolates the LAN8670 from MII/RMII.
  * @param lan Pointer to the lan8670_t instance.
  * @param setting true to isolate the device, false for normal operation.
- * @return 0 on success, or a non-zero error code from the read/write operations.
+ * @return 0 on success, or a non-zero error code.
  */
 int lan8670_isolate(lan8670_t *lan, bool setting); // Electrically isolates the LAN8670 from MII/RMII.
 
@@ -80,28 +80,69 @@ int lan8670_isolate(lan8670_t *lan, bool setting); // Electrically isolates the
  *   
  * @param lan Pointer to the lan8670_t instance.
  * @param setting true to enable collision test mode, false to disable it.
- * @return 0 on success, or a non-zero error code from the read/write operations.
+ * @return 0 on success, or a non-zero error code.
  */
 int lan8670_collision_test(lan8670_t *lan, bool setting); // Enables or disables the LAN8670's collision test mode.
 
 /**
  * @brief Detects jabber condition on the LAN8670.
  * @param lan Pointer to the lan8670_t instance.
  * @param jabber_status Pointer to a boolean variable to store the jabber status.
- * @return 0 on success, or a non-zero error code from the read operation.
+ * @return 0 on success, or a non-zero error code.
  */
 int lan8670_detect_jabber(lan8670_t *lan, bool *jabber_status); // Detects jabber condition on the LAN8670.
 
+/**
+ * @brief Enables or disables collision detection on the LAN8670.
+ * @param lan Pointer to the lan8670_t instance.
+ * @param setting true to enable collision detection, false to disable it.
+ * @return 0 on success, or a non-zero error code.
+ */
+int lan8670_collision_detection(lan8670_t *lan, bool setting);
+
 /**
  * @brief Enables or disables Physical Layer Collision Avoidence (PLCA).
  * 
- *  Note: When PLCA is enabled on a properly configured mixing segment, no collisions should occur
- *  on the physical layer. It is therefore recommended to disable physical layer collision detection to
- *  achieve a higher level of noise tolerance.
+ *  Note: When PLCA is enabled, collision detection should be disabled.
+ *  This can be done using the lan8670_collision_detection() function.
+ *  (See page 141 of the datasheet for more information.)
  *   
  * @param lan Pointer to the lan8670_t instance.
  * @param setting true to enable PLCA, false to disable it.
- * @return 0 on success, or a non-zero error code from the read/write operations.
+ * @return 0 on success, or a non-zero error code.
  */
-int lan8670_plca(lan8670_t *lan, bool setting);
+int lan8670_plca_on(lan8670_t *lan, bool setting);
+
+/**
+ * @brief Resets the PLCA reconciliation sublayer.
+ * 
+ * @param lan Pointer to the lan8670_t instance.
+ * @return 0 on success, or a non-zero error code.
+ */
+int lan8670_plca_reset(lan8670_t *lan);
+
+/**
+ * @brief Configures the maximum number of nodes supported on the multidrop network.
+ *  
+ * Proper operation requires that this field be set to at least the 
+ * number of nodes that may exist on the network.
+ * 
+ * @param lan Pointer to the lan8670_t instance.
+ * @param node_count The number of nodes on the network.
+ * @return 0 on success, or a non-zero error code.
+ */
+int lan8670_plca_set_node_count(lan8670_t *lan, uint8_t node_count);
+
+/**
+ * @brief Sets the ID of the PLCA node.
+ * 
+ * This ID must be unique for each node on the network.
+ * The ID for the controller node must be 0.
+ * 
+ * @param lan Pointer to the lan8670_t instance.
+ * @param id The ID of the PLCA node (0-31).
+ * @return 0 on success, or a non-zero error code.
+ */
+int lan8670_plca_set_node_id(lan8670_t *lan, uint8_t id);
+
 // clang-format on

general/src/lan8670.c

@@ -10,7 +10,6 @@
 
 #include <stdio.h> // Used for debug()
 #include <stdarg.h> // Used for debug()
-#include <assert.h> // Used for compile-time checks
 
 /* SMI Registers */
 #define REG_BASIC_CONTROL 		0x00 // Basic Control Register. (Datasheet pgs. 63-64)
@@ -449,27 +448,37 @@ int lan8670_collision_test(lan8670_t *lan, bool setting)
 
 int lan8670_detect_jabber(lan8670_t *lan, bool *jabber_status)
 {
-    // Read bit 1 of the Basic Status Register to 'jabber_status'. If it's 1, jabber is detected.
+    // Read bit 1 of the Basic Status Register to 'jabber_status'.
     return read_register_field(lan, REG_BASIC_STATUS, 1, 1, jabber_status);
 }
 
-int lan8670_plca_reset(lan8670_t *lan)
-{
-    // Set bit 14 in the PLCA Control 0 Register, and clear all other bits.
-    // This starts a software reset of the PLCA reconciliation sublayer. 
-	return mmd_write_register(lan, MMD_MISC, MISC_PLCA_CTRL0, 0x4000);
+int lan8670_collision_detection(lan8670_t *lan, bool setting) {
+    // Modify bit 15 of the Collision Detector Control 0 Register to whatever 'setting' is.
+    return mmd_write_register_field(lan, MMD_MISC, MISC_CDCTL0, 15, 15, setting);
 }
 
-int lan8670_plca(lan8670_t *lan, bool setting)
+int lan8670_plca_on(lan8670_t *lan, bool setting)
 {
     // Set/clear bit 15 of the PLCA Control 0 Register to whatever 'setting' is.
     return mmd_write_register_field(lan, MMD_MISC, MISC_PLCA_CTRL0, 15, 15, setting);
 }
 
+int lan8670_plca_reset(lan8670_t *lan)
+{
+    // Set bit 14 in the PLCA Control 0 Register, and clear all other bits.
+    // This starts a software reset of the PLCA reconciliation sublayer. 
+	return mmd_write_register(lan, MMD_MISC, MISC_PLCA_CTRL0, 0x4000);
+}
+
 int lan8670_plca_set_node_count(lan8670_t *lan, uint8_t node_count) 
 {
-    // Set bits 8-15 of the PLCA Control 1 Register to whatever 'node_count' is.
+    // Modify bits 8-15 of the PLCA Control 1 Register to whatever 'node_count' is.
 	return mmd_write_register_field(lan, MMD_MISC, MISC_PLCA_CTRL1, 8, 15, node_count);
 }
 
+int lan8670_plca_set_node_id(lan8670_t *lan, uint8_t id) 
+{
+    // Modify bits 0-7 of the PLCA Control 1 Register to whatever 'id' is.
+    return mmd_write_register_field(lan, MMD_MISC, MISC_PLCA_CTRL1, 0, 7, id);
+}
 // clang-format on