mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/Transaction.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
170:e95d10626187 
mbed library release version 165

Who changed what in which revision?

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