TUKS MCU Introductory course / TUKS-COURSE-TIMER

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-dev/platform/Transaction.h@2:5acdd8565d02, 2017-02-25 (annotated)

Committer:
elmot
Date:
Sat Feb 25 00:23:53 2017 +0000
Revision:
2:5acdd8565d02
Parent:
1:d0dfbce63a89 
Ready to show

Who changed what in which revision?

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