提交: 2fa9bf9fc8b6a1ea96f97df0a487df5878d4eb93 - shared_foo (git)

テスト用のあれこれ共用フォルダ

Commit MetaInfo

• 修订版: 2fa9bf9fc8b6a1ea96f97df0a487df5878d4eb93 (tree)
• 时间: 2017-11-06 06:23:15
• 作者: takemasa <suikan@user...>
• Commiter: takemasa

Log Message

Editing doxygen comment

更改概述

• modified: stm32_development/uart_class/platform/uart.cpp
• modified: stm32_development/uart_class/platform/uart.hpp

差异

--- a/stm32_development/uart_class/platform/uart.cpp
+++ b/stm32_development/uart_class/platform/uart.cpp
@@ -29,6 +29,7 @@ UART::~UART() {
     vSemaphoreDelete(mutex_protect_tx_);
 }
 
+//todo: modify to return the boolean value.
 bool UART::Transmit(uint8_t * data, uint16_t size, WaitMilliSeconds timeout_ms)
 {
     EnterProtection(mutex_protect_tx_);
@@ -52,6 +53,7 @@ bool UART::CompleteEntireTransmit(void* ptr) {
     }
 }
 
+//todo: modify to return the boolean value.
 bool UART::Receive(uint8_t * data, uint16_t size, WaitMilliSeconds timeout_ms) {
     EnterProtection(mutex_protect_rx_);
 

--- a/stm32_development/uart_class/platform/uart.hpp
+++ b/stm32_development/uart_class/platform/uart.hpp
@@ -52,8 +52,52 @@ class UART : public AbstractUART {
      * Convenience, this function is forbiddedn to call from ISR.
      */
     virtual bool Transmit(uint8_t * data, uint16_t count, WaitMilliSeconds timeout_ms);
+    /**
+     * \brief Receive raw data through UART by blocking mode.
+     * \param data Data buffer to place the received data..
+     * \param count The count of the data ( byte ) to be transfered.
+     * \param timeout_ms Time out limit by milliseconds.
+     * \return  True if all data transfered completely. False if time out happen.
+     * \details
+     * Receive to given data buffer through the UART device.
+     *
+     * The receiving mode is blocking. That means, function returns when specified number of data has been received, except timeout.
+     * Passing kIndefinitely to the parameter timeout_ms orders not to return until complete receiving. Other value of
+     * timeout_ms parameter specifies the time out by millisecond. If time out happen, function returns false. If not happen, it returns true.
+     *
+     * This function is exclusive. Internally this function is guarded by mutex. Then this function is thread safe. In return for this
+     * Convenience, this function is forbiddedn to call from ISR.
+     */
     virtual bool Receive(uint8_t * data, uint16_t count, WaitMilliSeconds timeout_ms);
+    /**
+     * \brief Call back to be called for entire block transfer is complete.
+     * \param ptr Pointer to UART_HandleTypeDef struct.
+     * \return true: ptr matches with UART device and handle the call back. false : doesn't match.
+     * \details
+     * A call back to notify the end of entire block transfer. This is considered for DMA based transmission and
+     * called from an DMA ISR.
+     *
+     * An object of this class checks whether the given ptr parameter matches its own device, and if matched,
+     * Release the waiting task and return true. If it doesn't match, just return false.
+     *
+     * This method have to be called from ISR context.
+     */
+
     virtual bool CompleteEntireTransmit(void* ptr);
+    /**
+     * \brief Call back to be called for entire block transfer is complete.
+     * \param ptr Pointer to UART_HandleTypeDef struct.
+     * \return true: ptr matches with UART device and handle the call back. false : doesn't match.
+     * \details
+     * A call back to notify the end of entire block transfer. This is considered for DMA based receiving and
+     * called from an DMA ISR.
+     *
+     * An object of this class checks whether the given ptr parameter matches its own device, and if matched,
+     * Release the waiting task and return true. If it doesn't match, just return false.
+     *
+     * This method have to be called from ISR context.
+     */
+
     virtual bool CompleteEntireReceive(void* ptr);
  private:
     UART_HandleTypeDef* uart_;