Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

platform/Transaction.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
NYX 0:85b3fd62ea1a 1 /* mbed Microcontroller Library
NYX 0:85b3fd62ea1a 2 * Copyright (c) 2015 ARM Limited
NYX 0:85b3fd62ea1a 3 *
NYX 0:85b3fd62ea1a 4 * Licensed under the Apache License, Version 2.0 (the "License");
NYX 0:85b3fd62ea1a 5 * you may not use this file except in compliance with the License.
NYX 0:85b3fd62ea1a 6 * You may obtain a copy of the License at
NYX 0:85b3fd62ea1a 7 *
NYX 0:85b3fd62ea1a 8 * http://www.apache.org/licenses/LICENSE-2.0
NYX 0:85b3fd62ea1a 9 *
NYX 0:85b3fd62ea1a 10 * Unless required by applicable law or agreed to in writing, software
NYX 0:85b3fd62ea1a 11 * distributed under the License is distributed on an "AS IS" BASIS,
NYX 0:85b3fd62ea1a 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
NYX 0:85b3fd62ea1a 13 * See the License for the specific language governing permissions and
NYX 0:85b3fd62ea1a 14 * limitations under the License.
NYX 0:85b3fd62ea1a 15 */
NYX 0:85b3fd62ea1a 16 #ifndef MBED_TRANSACTION_H
NYX 0:85b3fd62ea1a 17 #define MBED_TRANSACTION_H
NYX 0:85b3fd62ea1a 18
NYX 0:85b3fd62ea1a 19 #include "platform/platform.h"
NYX 0:85b3fd62ea1a 20 #include "platform/FunctionPointer.h"
NYX 0:85b3fd62ea1a 21
NYX 0:85b3fd62ea1a 22 namespace mbed {
NYX 0:85b3fd62ea1a 23 /** \addtogroup platform */
NYX 0:85b3fd62ea1a 24
NYX 0:85b3fd62ea1a 25 /** Transaction structure
NYX 0:85b3fd62ea1a 26 * @ingroup platform
NYX 0:85b3fd62ea1a 27 */
NYX 0:85b3fd62ea1a 28 typedef struct {
NYX 0:85b3fd62ea1a 29 void *tx_buffer; /**< Tx buffer */
NYX 0:85b3fd62ea1a 30 size_t tx_length; /**< Length of Tx buffer*/
NYX 0:85b3fd62ea1a 31 void *rx_buffer; /**< Rx buffer */
NYX 0:85b3fd62ea1a 32 size_t rx_length; /**< Length of Rx buffer */
NYX 0:85b3fd62ea1a 33 uint32_t event; /**< Event for a transaction */
NYX 0:85b3fd62ea1a 34 event_callback_t callback; /**< User's callback */
NYX 0:85b3fd62ea1a 35 uint8_t width; /**< Buffer's word width (8, 16, 32, 64) */
NYX 0:85b3fd62ea1a 36 } transaction_t;
NYX 0:85b3fd62ea1a 37
NYX 0:85b3fd62ea1a 38 /** Transaction class defines a transaction.
NYX 0:85b3fd62ea1a 39 *
NYX 0:85b3fd62ea1a 40 * @note Synchronization level: Not protected
NYX 0:85b3fd62ea1a 41 * @ingroup platform
NYX 0:85b3fd62ea1a 42 */
NYX 0:85b3fd62ea1a 43 template<typename Class>
NYX 0:85b3fd62ea1a 44 class Transaction {
NYX 0:85b3fd62ea1a 45 public:
NYX 0:85b3fd62ea1a 46 Transaction(Class *tpointer, const transaction_t& transaction) : _obj(tpointer), _data(transaction) {
NYX 0:85b3fd62ea1a 47 }
NYX 0:85b3fd62ea1a 48
NYX 0:85b3fd62ea1a 49 Transaction() : _obj(), _data() {
NYX 0:85b3fd62ea1a 50 }
NYX 0:85b3fd62ea1a 51
NYX 0:85b3fd62ea1a 52 ~Transaction() {
NYX 0:85b3fd62ea1a 53 }
NYX 0:85b3fd62ea1a 54
NYX 0:85b3fd62ea1a 55 /** Get object's instance for the transaction
NYX 0:85b3fd62ea1a 56 *
NYX 0:85b3fd62ea1a 57 * @return The object which was stored
NYX 0:85b3fd62ea1a 58 */
NYX 0:85b3fd62ea1a 59 Class* get_object() {
NYX 0:85b3fd62ea1a 60 return _obj;
NYX 0:85b3fd62ea1a 61 }
NYX 0:85b3fd62ea1a 62
NYX 0:85b3fd62ea1a 63 /** Get the transaction
NYX 0:85b3fd62ea1a 64 *
NYX 0:85b3fd62ea1a 65 * @return The transaction which was stored
NYX 0:85b3fd62ea1a 66 */
NYX 0:85b3fd62ea1a 67 transaction_t* get_transaction() {
NYX 0:85b3fd62ea1a 68 return &_data;
NYX 0:85b3fd62ea1a 69 }
NYX 0:85b3fd62ea1a 70
NYX 0:85b3fd62ea1a 71 private:
NYX 0:85b3fd62ea1a 72 Class* _obj;
NYX 0:85b3fd62ea1a 73 transaction_t _data;
NYX 0:85b3fd62ea1a 74 };
NYX 0:85b3fd62ea1a 75
NYX 0:85b3fd62ea1a 76 }
NYX 0:85b3fd62ea1a 77
NYX 0:85b3fd62ea1a 78 #endif