Skip to content

Commit d6aee50

Browse files
Added comments noting which functions have not been explicitly tested in the app layer yet.
1 parent b4403c4 commit d6aee50

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

general/include/lan8670.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ int32_t LAN8670_Reset(lan8670_t *lan); // Performs a software reset of the LAN86
7272
* @param setting true to enable loopback mode, false to disable it.
7373
* @return Status.
7474
*/
75-
int32_t LAN8670_Loopback(lan8670_t *lan, bool setting); // Enables or disables loopback mode on the LAN8670.
75+
int32_t LAN8670_Loopback(lan8670_t *lan, bool setting); // NOTE: This function has not been tested yet (as of 01/31/2026).
7676

7777
/**
7878
* @brief Enables or disables the LAN8670's low power mode.
@@ -84,15 +84,15 @@ int32_t LAN8670_Loopback(lan8670_t *lan, bool setting); // Enables or disables l
8484
* @param setting true to enable low power mode, false to disable it.
8585
* @return Status.
8686
*/
87-
int32_t LAN8670_Low_Power_Mode(lan8670_t *lan, bool setting); // Enables or disables the LAN8670's low power mode.
87+
int32_t LAN8670_Low_Power_Mode(lan8670_t *lan, bool setting); // NOTE: This function has not been tested yet (as of 01/31/2026).
8888

8989
/**
9090
* @brief Electrically isolates the LAN8670 from MII/RMII.
9191
* @param lan Pointer to the lan8670_t instance.
9292
* @param setting true to isolate the device, false for normal operation.
9393
* @return Status.
9494
*/
95-
int32_t LAN8670_Isolate(lan8670_t *lan, bool setting); // Electrically isolates the LAN8670 from MII/RMII.
95+
int32_t LAN8670_Isolate(lan8670_t *lan, bool setting); // NOTE: This function has not been tested yet (as of 01/31/2026).
9696

9797
/**
9898
* @brief Enables or disables the LAN8670's collision test mode.
@@ -105,7 +105,7 @@ int32_t LAN8670_Isolate(lan8670_t *lan, bool setting); // Electrically isolates
105105
* @param setting true to enable collision test mode, false to disable it.
106106
* @return Status.
107107
*/
108-
int32_t LAN8670_Collision_Test(lan8670_t *lan, bool setting); // Enables or disables the LAN8670's collision test mode.
108+
int32_t LAN8670_Collision_Test(lan8670_t *lan, bool setting); // NOTE: This function has not been tested yet (as of 01/31/2026).
109109

110110
/**
111111
* @brief Enables or disables collision detection on the LAN8670.
@@ -134,7 +134,7 @@ int32_t LAN8670_PLCA_On(lan8670_t *lan, bool setting);
134134
* @param lan Pointer to the lan8670_t instance.
135135
* @return Status.
136136
*/
137-
int32_t LAN8670_PLCA_Reset(lan8670_t *lan);
137+
int32_t LAN8670_PLCA_Reset(lan8670_t *lan); // NOTE: This function has not been tested yet (as of 01/31/2026).
138138

139139
/**
140140
* @brief Configures the maximum number of nodes supported on the multidrop network.
@@ -190,7 +190,7 @@ int32_t LAN8670_RegisterBusIO(lan8670_t *lan, lan8670_IOCtx_t *ioctx);
190190
* @param status Buffer for the returned status value. false=The PLCA reconciliation sublayer is not regularly receiving or transmitting the BEACON, true=The PLCA reconciliation sublayer is regularly receiving or transmitting the BEACON
191191
* @return Status (an error code, not related to the *status bool).
192192
*/
193-
int32_t LAN8670_PLCA_Get_Status(lan8670_t *lan, bool *status);
193+
int32_t LAN8670_PLCA_Get_Status(lan8670_t *lan, bool *status); // NOTE: This function has not been tested yet (as of 01/31/2026).
194194

195195
/**
196196
* @brief Reads the PLCA TOTMR (Transmit Opportunity Timer) setting. Should be 32 bit-times by default.
@@ -199,7 +199,7 @@ int32_t LAN8670_PLCA_Get_Status(lan8670_t *lan, bool *status);
199199
* @param buffer Buffer for the register value. The value has a unit of bit-times.
200200
* @return Status.
201201
*/
202-
int32_t LAN8670_PLCA_ReadTOTMR(lan8670_t *lan, bool *buffer);
202+
int32_t LAN8670_PLCA_ReadTOTMR(lan8670_t *lan, bool *buffer); // NOTE: This function has not been tested yet (as of 01/31/2026).
203203

204204
/**
205205
* @brief Writes the PLCA TOTMR (Transmit Opportunity Timer) setting.
@@ -208,6 +208,6 @@ int32_t LAN8670_PLCA_ReadTOTMR(lan8670_t *lan, bool *buffer);
208208
* @param data Setting to write to the register. Should be an integer with a unit of bit-times.
209209
* @return Status.
210210
*/
211-
int32_t LAN8670_PLCA_WriteTOTMR(lan8670_t *lan, uint8_t data);
211+
int32_t LAN8670_PLCA_WriteTOTMR(lan8670_t *lan, uint8_t data); // NOTE: This function has not been tested yet (as of 01/31/2026).
212212

213213
// clang-format on

0 commit comments

Comments
 (0)