Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/platform/Transaction.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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