Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

Transaction.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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