Aditya Mehrotra / mbed-dev

Biomimetics MBED Library w/ Added Support for CAN3

Dependents:   CAN_TEST SPIne_Plus_DYNO_SENSORS SPIne_Plus_v2 SPIne_Plus_Dyno_v2

platform/Transaction.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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