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