Commit: 5f55c2e3c50ac688accb6eb4e35e110844bda442 - shared_foo_backup (git)

shared_fooの不要ディレクトリ削除前のもの

Commit MetaInfo

• Revision: 5f55c2e3c50ac688accb6eb4e35e110844bda442 (tree)
• Zeit: 2018-02-11 16:57:54
• Autor: takemasa <suikan@user...>
• Commiter: takemasa

Log Message

Added new abstract classes.

Ändern Zusammenfassung

• add: stm32_development/murasaki/murasaki/abstracti2cmaster.hpp
• add: stm32_development/murasaki/murasaki/abstractspimaster.hpp
• add: stm32_development/murasaki/murasaki/abstractspimasterdecorator.hpp
• modified: stm32_development/murasaki/murasaki/uart.cpp

Diff

--- /dev/null
+++ b/stm32_development/murasaki/murasaki/abstracti2cmaster.hpp
@@ -0,0 +1,119 @@
+/**
+ * \file abstracti2cmaster.hpp
+ *
+ *  \date  2018/02/11
+ *  \author: takemasa
+ *  \brief Root class definition of the I2C Master.
+ */
+
+#ifndef ABSTRACTI2CMASTER_HPP_
+#define ABSTRACTI2CMASTER_HPP_
+
+#include "murasaki_defs.hpp"
+
+namespace murasaki {
+/**
+ * \ingroup MURASAKI_ABSTRACT_GROUP
+ * \brief Definition of the root class of I2C master.
+ * \details
+ * A prototype of the I2C master peripheral.
+ *
+ * This prototype assumes the derived class will transmit / receive data in the
+ * task context on RTOS. And these member functions should be blocking.
+ * That men, until the transmit / receive
+ * terminates, both method doesn't return.
+ *
+ * Two call back member functions are prepared to sync with the interrupt which tells the end of
+ * Transmit/Recieve.
+ */
+
+class AbstractI2CMaster
+{
+ public:
+    /**
+     * \brief Destructor. Declared to enforce the derived destructor is virtual.
+     */
+    virtual ~AbstractI2CMaster()
+    {
+    }
+    ;
+
+    /**
+     * @brief Thread safe, blocking transmission over I2C.
+     * @param addrs 7bit address of the I2C device.
+     * @param tx_data Data array to transmit.
+     * @param tx_count Data counts[bytes] to transmit.
+     * @param timeout_ms Time ou [mS]. By default, there is not timeout.
+     * @return True if transmit complete, false if timeout.
+     * @details
+     * This member function is confided to run in the task context of RTOS. This should be internally
+     * exclusive between multiple task access. In other word, it should be thread save.
+     */
+    virtual bool Transmit(uint addrs, uint8_t * tx_data, uint16_t tx_count, WaitMilliSeconds timeout_ms =
+                                  murasaki::kwmsIndefinitely) = 0;
+    /**
+     * @brief Thread safe, blocking receiving over I2C.
+     * @param addrs 7bit address of the I2C device.
+     * @param rx_data Data array to transmit.
+     * @param rx_count Data counts[bytes] to transmit.
+     * @param timeout_ms Time ou [mS]. By default, there is not timeout.
+     * @return True if receiving complete, false if timeout.
+     * @details
+     * This member function is confided to run in the task context of RTOS. This should be internally
+     * exclusive between multiple task access. In other word, it should be thread save.
+     */
+    virtual bool Receive(uint addrs, uint8_t * rx_data, uint16_t rx_count, WaitMilliSeconds timeout_ms =
+                                 murasaki::kwmsIndefinitely) = 0;
+    /**
+     * @brief Thread safe, blocking transmission and then receiving over I2C.
+     * @param addrs 7bit address of the I2C device.
+     * @param tx_data Data array to transmit.
+     * @param tx_count Data counts[bytes] to transmit.
+     * @param rx_data Data array to transmit.
+     * @param rx_count Data counts[bytes] to transmit.
+     * @param timeout_ms Time ou [mS]. By default, there is not timeout.
+     * @return True if receiving complete, false if timeout.
+     * @details
+     * First, this member function transmit the data, and the, by repeated start function,
+     * it receives data. The transmission device address and receiving device address is same.
+     *
+     * This member function is confided to run in the task context of RTOS. This should be internally
+     * exclusive between multiple task access. In other word, it should be thread save.
+     *
+     */
+    virtual bool TransmitThenReceive(uint addrs,
+                                     uint8_t * tx_data,
+                                     uint16_t tx_count,
+                                     uint8_t * rx_data,
+                                     uint16_t rx_count,
+                                     WaitMilliSeconds timeout_ms = murasaki::kwmsIndefinitely) =0;
+    /**
+     * \brief Call back to be called notify the transfer is complete.
+     * \param ptr Pointer for generic use. Usually, points a struct of a peripheral control
+     * \return true: ptr matches with peripheral and handle the call back. false : doesn't match.
+     * \details
+     * A call back to notify the end of entire block or byte transfer. The definition of calling timing is
+     * depend on the implementation. This is called from an DMA ISR.
+     *
+     *
+     * Typically, an implementation may check whether the given ptr parameter matches its own device, and if matched, handle it
+     * and return true. If it doesn't match, just return false.
+     */
+    virtual bool TransmitCompleteCallback(void* ptr)=0;
+    /**
+     * \brief Call back to be called for entire block transfer is complete.
+     * \param ptr Pointer for generic use. Usually, points a struct of a peripheral control
+     * \return true: ptr matches with peripheral and handle the call back. false : doesn't match.
+     * \details
+     * A call back to notify the end of entire block or byte transfer. The definition of calling timing is
+     * depend on the implementation. This is called from an DMA ISR.
+     *
+     * Typically, an implementation may check whether the given ptr parameter matches its own device, and if matched, handle it
+     * and return true. If it doesn't match, just return false.
+     */
+    virtual bool ReceiveCompleteCallback(void* ptr) = 0;
+};
+
+} /* namespace murasaki */
+
+#endif /* ABSTRACTI2CMASTER_HPP_ */

--- /dev/null
+++ b/stm32_development/murasaki/murasaki/abstractspimaster.hpp
@@ -0,0 +1,22 @@
+/*
+ * abstractspimaster.hpp
+ *
+ *  Created on: 2018/02/11
+ *      Author: takemasa
+ */
+
+#ifndef ABSTRACTSPIMASTER_HPP_
+#define ABSTRACTSPIMASTER_HPP_
+
+namespace murasaki {
+
+class AbstractSpiMaster
+{
+ public:
+    AbstractSpiMaster();
+    virtual ~AbstractSpiMaster();
+};
+
+} /* namespace murasaki */
+
+#endif /* ABSTRACTSPIMASTER_HPP_ */

--- /dev/null
+++ b/stm32_development/murasaki/murasaki/abstractspimasterdecorator.hpp
@@ -0,0 +1,22 @@
+/*
+ * abstractspimasterdecorator.hpp
+ *
+ *  Created on: 2018/02/11
+ *      Author: takemasa
+ */
+
+#ifndef ABSTRACTSPIMASTERDECORATOR_HPP_
+#define ABSTRACTSPIMASTERDECORATOR_HPP_
+
+namespace murasaki {
+
+class AbstractSpiMasterDecorator
+{
+ public:
+    AbstractSpiMasterDecorator();
+    virtual ~AbstractSpiMasterDecorator();
+};
+
+} /* namespace murasaki */
+
+#endif /* ABSTRACTSPIMASTERDECORATOR_HPP_ */

--- a/stm32_development/murasaki/murasaki/uart.cpp
+++ b/stm32_development/murasaki/murasaki/uart.cpp
@@ -50,6 +50,7 @@ Uart::~Uart()
 
 void Uart::SetHardwareFlowControl(UartHardwareFlowControl control)
 {
+    //TODO need to rewrite.
     // stop UART activity. This is required by UART HAL specification.
     __HAL_UART_DISABLE(uart_);