Christopher Haster / mbed-hal

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.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/Transaction.h@0:9c59db1fbc9e, 2016-03-23 (annotated)

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Child:
7:4fdb3a44f646
Initial revision

Who changed what in which revision?

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