Hiroh Satoh / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   keyboard

Fork of mbed-dev by mbed official

api/Transaction.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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