Gan likun / mbed-dev

00

platform/Transaction.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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