Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/platform/Transaction.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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