BA / Mbed OS BaBoRo1

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-os/platform/Transaction.h@0:380207fcb5c1, 2018-03-29 (annotated)

Committer:
borlanic
Date:
Thu Mar 29 07:02:09 2018 +0000
Revision:
0:380207fcb5c1
Encoder, IMU --> OK; Controller --> in bearbeitung

Who changed what in which revision?

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