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@143:86740a56073b, 2017-05-26 (annotated)

Committer:
AnnaBridge
Date:
Fri May 26 12:30:20 2017 +0100
Revision:
143:86740a56073b
Parent:
128:9bcdf88f62b0
Child:
145:64910690c574
Release 143 of the mbed library.

Who changed what in which revision?

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