Nicolas Borla / Mbed OS BBR_1Ebene

BBR 1 Ebene

mbed-os/platform/Transaction.h@0:fbdae7e6d805, 2018-05-14 (annotated)

Committer:
borlanic
Date:
Mon May 14 11:29:06 2018 +0000
Revision:
0:fbdae7e6d805
BBR

Who changed what in which revision?

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