mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/platform/Transaction.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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