AppNearMe / MicroNFCBoardAPI

NFC API for mbed using the MicroNFCBoard as a peripheral

Dependents:   MicroNFCBoardAPI_P2P_Client MicroNFCBoardAPI_Blink MicroNFCBoardAPI_Tag_Emulator MicroNFCBoardAPI_Tag_Reader ... more

transport.h@1:1d246e0872c6, 2015-04-24 (annotated)

Committer:
AppNearMe
Date:
Fri Apr 24 12:59:31 2015 +0000
Revision:
1:1d246e0872c6
Parent:
0:07fa9c0dd549
Child:
2:9b0733b8fa95
Set license to Apache 2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AppNearMe 1:1d246e0872c6 1 /*
AppNearMe 1:1d246e0872c6 2 MicroNFCBoard mbed API
AppNearMe 1:1d246e0872c6 3
AppNearMe 1:1d246e0872c6 4 Copyright (c) 2014-2015 AppNearMe Ltd
AppNearMe 1:1d246e0872c6 5
AppNearMe 1:1d246e0872c6 6 Licensed under the Apache License, Version 2.0 (the "License");
AppNearMe 1:1d246e0872c6 7 you may not use this file except in compliance with the License.
AppNearMe 1:1d246e0872c6 8 You may obtain a copy of the License at
AppNearMe 1:1d246e0872c6 9
AppNearMe 1:1d246e0872c6 10 http://www.apache.org/licenses/LICENSE-2.0
AppNearMe 1:1d246e0872c6 11
AppNearMe 1:1d246e0872c6 12 Unless required by applicable law or agreed to in writing, software
AppNearMe 1:1d246e0872c6 13 distributed under the License is distributed on an "AS IS" BASIS,
AppNearMe 1:1d246e0872c6 14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AppNearMe 1:1d246e0872c6 15 See the License for the specific language governing permissions and
AppNearMe 1:1d246e0872c6 16 limitations under the License.
AppNearMe 0:07fa9c0dd549 17 */
AppNearMe 0:07fa9c0dd549 18 #ifndef SRC_TRANSPORT_H_
AppNearMe 0:07fa9c0dd549 19 #define SRC_TRANSPORT_H_
AppNearMe 0:07fa9c0dd549 20
AppNearMe 0:07fa9c0dd549 21 #include "mbed.h"
AppNearMe 0:07fa9c0dd549 22 #include <cstddef>
AppNearMe 0:07fa9c0dd549 23
AppNearMe 0:07fa9c0dd549 24 class Transport
AppNearMe 0:07fa9c0dd549 25 {
AppNearMe 0:07fa9c0dd549 26 public:
AppNearMe 0:07fa9c0dd549 27 Transport(PinName mosi, PinName miso, PinName sck, PinName cs, PinName irq);
AppNearMe 0:07fa9c0dd549 28
AppNearMe 0:07fa9c0dd549 29 void init();
AppNearMe 0:07fa9c0dd549 30
AppNearMe 0:07fa9c0dd549 31 void reset();
AppNearMe 0:07fa9c0dd549 32
AppNearMe 0:07fa9c0dd549 33 bool statusChanged();
AppNearMe 0:07fa9c0dd549 34
AppNearMe 0:07fa9c0dd549 35 uint32_t status();
AppNearMe 0:07fa9c0dd549 36
AppNearMe 0:07fa9c0dd549 37 void nfcPoll(bool enable);
AppNearMe 0:07fa9c0dd549 38
AppNearMe 0:07fa9c0dd549 39 void nfcOperation(bool readOp, bool writeOp);
AppNearMe 0:07fa9c0dd549 40
AppNearMe 0:07fa9c0dd549 41 void nfcGetInfoIsoA(uint8_t* atqa, uint8_t* sak, uint8_t* uid, size_t* pUidLength);
AppNearMe 0:07fa9c0dd549 42
AppNearMe 0:07fa9c0dd549 43 void nfcGetMessageInfo(size_t* pRecordCount);
AppNearMe 0:07fa9c0dd549 44
AppNearMe 0:07fa9c0dd549 45 void nfcSetMessageInfo(size_t recordCount);
AppNearMe 0:07fa9c0dd549 46
AppNearMe 0:07fa9c0dd549 47 void nfcGetRecordInfo(size_t recordNumber, uint16_t* pType, uint16_t* info, size_t infoCount);
AppNearMe 0:07fa9c0dd549 48
AppNearMe 0:07fa9c0dd549 49 void nfcSetRecordInfo(size_t recordNumber, uint16_t type, uint16_t* info, size_t infoCount);
AppNearMe 0:07fa9c0dd549 50
AppNearMe 0:07fa9c0dd549 51 void nfcGetRecordData(size_t recordNumber, size_t item, size_t offset, uint8_t* data, size_t length);
AppNearMe 0:07fa9c0dd549 52
AppNearMe 0:07fa9c0dd549 53 void nfcSetRecordData(size_t recordNumber, size_t item, size_t offset, uint8_t* data, size_t length);
AppNearMe 0:07fa9c0dd549 54
AppNearMe 0:07fa9c0dd549 55 void nfcPrepareMessage(bool lock, bool generate);
AppNearMe 0:07fa9c0dd549 56
AppNearMe 0:07fa9c0dd549 57 void nfcDecodePrefix(uint8_t prefix, char* data, size_t* pDataLength);
AppNearMe 0:07fa9c0dd549 58
AppNearMe 0:07fa9c0dd549 59 void nfcEncodePrefix(uint8_t* pPrefix, char* data, size_t dataLength);
AppNearMe 0:07fa9c0dd549 60
AppNearMe 0:07fa9c0dd549 61 void leds(bool led1, bool led2);
AppNearMe 0:07fa9c0dd549 62
AppNearMe 0:07fa9c0dd549 63 protected:
AppNearMe 0:07fa9c0dd549 64 enum CommandError
AppNearMe 0:07fa9c0dd549 65 {
AppNearMe 0:07fa9c0dd549 66 OK = 0,
AppNearMe 0:07fa9c0dd549 67 ERR_LENGTH = 1,
AppNearMe 0:07fa9c0dd549 68 ERR_EMPTY = 2,
AppNearMe 0:07fa9c0dd549 69 ERR_UNKNOWN_COMMAND = 3,
AppNearMe 0:07fa9c0dd549 70 ERR_TIMEOUT = 4,
AppNearMe 0:07fa9c0dd549 71 ERR_PARAMS = 5,
AppNearMe 0:07fa9c0dd549 72 ERR_STATUS = 6,
AppNearMe 0:07fa9c0dd549 73 };
AppNearMe 0:07fa9c0dd549 74
AppNearMe 0:07fa9c0dd549 75 enum CommandCode
AppNearMe 0:07fa9c0dd549 76 {
AppNearMe 0:07fa9c0dd549 77 GET_STATUS = 0,
AppNearMe 0:07fa9c0dd549 78 INFO = 1,
AppNearMe 0:07fa9c0dd549 79 RESET = 2,
AppNearMe 0:07fa9c0dd549 80 LEDS = 3,
AppNearMe 0:07fa9c0dd549 81 NFC_POLL = 4,
AppNearMe 0:07fa9c0dd549 82 NFC_OPERATION = 5,
AppNearMe 0:07fa9c0dd549 83 NFC_GET_INFO = 6,
AppNearMe 0:07fa9c0dd549 84 NFC_GET_MESSAGE_INFO = 7,
AppNearMe 0:07fa9c0dd549 85 NFC_GET_RECORD_INFO = 8,
AppNearMe 0:07fa9c0dd549 86 NFC_GET_RECORD_DATA = 9,
AppNearMe 0:07fa9c0dd549 87 NFC_SET_MESSAGE_INFO = 10,
AppNearMe 0:07fa9c0dd549 88 NFC_SET_RECORD_INFO = 11,
AppNearMe 0:07fa9c0dd549 89 NFC_SET_RECORD_DATA = 12,
AppNearMe 0:07fa9c0dd549 90 NFC_PREPARE_MESSAGE = 13,
AppNearMe 0:07fa9c0dd549 91 NFC_DECODE_PREFIX = 14,
AppNearMe 0:07fa9c0dd549 92 NFC_ENCODE_PREFIX = 15
AppNearMe 0:07fa9c0dd549 93 };
AppNearMe 0:07fa9c0dd549 94
AppNearMe 0:07fa9c0dd549 95 CommandError command(CommandCode command, uint8_t* outBuf, size_t outLength, uint8_t* inBuf, size_t inLength);
AppNearMe 0:07fa9c0dd549 96
AppNearMe 0:07fa9c0dd549 97 private:
AppNearMe 0:07fa9c0dd549 98 DigitalOut _cs;
AppNearMe 0:07fa9c0dd549 99 SPI _spi;
AppNearMe 0:07fa9c0dd549 100 DigitalIn _int;
AppNearMe 0:07fa9c0dd549 101 };
AppNearMe 0:07fa9c0dd549 102
AppNearMe 0:07fa9c0dd549 103
AppNearMe 0:07fa9c0dd549 104
AppNearMe 0:07fa9c0dd549 105 #endif /* SRC_TRANSPORT_H_ */