Rename otPlatSerial* to otPlatUart*. (#253)

include/cli/Makefile.am

@@ -29,7 +29,7 @@
 include $(abs_top_nlbuild_autotools_dir)/automake/pre.am
 
 ot_cli_headers                          = \
-    cli-serial.h                          \
+    cli-uart.h                            \
     $(NULL)
 
 ot_clidir = $(includedir)/cli

include/cli/cli-uart.h

@@ -32,18 +32,18 @@
  *  This file defines the top-level functions for the OpenThread CLI server.
  */
 
-#ifndef CLI_SERIAL_H_
-#define CLI_SERIAL_H_
+#ifndef CLI_UART_H_
+#define CLI_UART_H_
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
- * Initialize the CLI serial server.
+ * Initialize the CLI UART module.
  *
  */
-void otCliSerialInit(void);
+void otCliUartInit(void);
 
 #ifdef __cplusplus
 }  // extern "C"

include/ncp/ncp.h

@@ -29,7 +29,7 @@
 /**
  * @file
  * @brief
- *  This file defines the top-level functions for the OpenThread CLI server.
+ *  This file defines the top-level functions for the OpenThread NCP module.
  */
 
 #ifndef NCP_H_
@@ -40,7 +40,7 @@ extern "C" {
 #endif
 
 /**
- * Initialize the CLI serial server.
+ * Initialize the NCP.
  *
  */
 void otNcpInit(void);

include/platform/Makefile.am

@@ -33,7 +33,7 @@ ot_platform_headers                      =\
     logging.h                             \
     radio.h                               \
     random.h                              \
-    serial.h                              \
+    uart.h                                \
     spi-slave.h                           \
     toolchain.h                           \
     $(NULL)

include/platform/uart.h

@@ -29,11 +29,11 @@
 /**
  * @file
  * @brief
- *   This file includes the platform abstraction for serial communication.
+ *   This file includes the platform abstraction for UART communication.
  */
 
-#ifndef SERIAL_H_
-#define SERIAL_H_
+#ifndef UART_H_
+#define UART_H_
 
 #include <stdint.h>
 
@@ -44,57 +44,57 @@ extern "C" {
 #endif
 
 /**
- * @defgroup serial Serial
+ * @defgroup uart UART
  * @ingroup platform
  *
  * @brief
- *   This module includes the platform abstraction for serial communication.
+ *   This module includes the platform abstraction for UART communication.
  *
  * @{
  *
  */
 
 /**
- * Enable the serial.
+ * Enable the UART.
  *
- * @retval ::kThreadError_None  Successfully enabled the serial.
- * @retval ::kThreadError_Fail  Failed to enabled the serial.
+ * @retval ::kThreadError_None    Successfully enabled the UART.
+ * @retval ::kThreadError_Failed  Failed to enabled the UART.
  */
-ThreadError otPlatSerialEnable(void);
+ThreadError otPlatUartEnable(void);
 
 /**
- * Disable the serial.
+ * Disable the UART.
  *
- * @retval ::kThreadError_None  Successfully disabled the serial.
- * @retval ::kThreadError_Fail  Failed to disable the serial.
+ * @retval ::kThreadError_None    Successfully disabled the UART.
+ * @retval ::kThreadError_Failed  Failed to disable the UART.
  */
-ThreadError otPlatSerialDisable(void);
+ThreadError otPlatUartDisable(void);
 
 /**
- * Send bytes over the serial.
+ * Send bytes over the UART.
  *
  * @param[in] aBuf        A pointer to the data buffer.
  * @param[in] aBufLength  Number of bytes to transmit.
  *
- * @retval ::kThreadError_None  Successfully started transmission.
- * @retval ::kThreadError_Fail  Failed to start the transmission.
+ * @retval ::kThreadError_None    Successfully started transmission.
+ * @retval ::kThreadError_Failed  Failed to start the transmission.
  */
-ThreadError otPlatSerialSend(const uint8_t *aBuf, uint16_t aBufLength);
+ThreadError otPlatUartSend(const uint8_t *aBuf, uint16_t aBufLength);
 
 /**
- * The serial driver calls this method to notify OpenThread that the requested bytes have been sent.
+ * The UART driver calls this method to notify OpenThread that the requested bytes have been sent.
  *
  */
-extern void otPlatSerialSendDone(void);
+extern void otPlatUartSendDone(void);
 
 /**
- * The serial driver calls this method to notify OpenThread that bytes have been received.
+ * The UART driver calls this method to notify OpenThread that bytes have been received.
  *
  * @param[in]  aBuf        A pointer to the received bytes.
  * @param[in]  aBufLength  The number of bytes received.
  *
  */
-extern void otPlatSerialReceived(const uint8_t *aBuf, uint16_t aBufLength);
+extern void otPlatUartReceived(const uint8_t *aBuf, uint16_t aBufLength);
 
 /**
  * @}
@@ -105,4 +105,4 @@ extern void otPlatSerialReceived(const uint8_t *aBuf, uint16_t aBufLength);
 }  // extern "C"
 #endif
 
-#endif  // SERIAL_H_
+#endif  // UART_H_