PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/Transaction.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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