Greg Steiert / maxim_dev

Dependents:   sensomed

platform/Transaction.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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