Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/Transaction.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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