EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

platform/Transaction.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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