Gan likun / mbed-dev11

platform/Transaction.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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