SkyTEM BMAG / Mbed 2 deprecated BMAGThrRev

Bmag incl gps rettelse

Dependencies:   mbed WDT MODSERIAL BME280

USBHost/USBHost3GModule/IUSBHostSerial.h@61:52a6d0ffd8e5, 2019-07-05 (annotated)

Committer:
gert_lauritsen
Date:
Fri Jul 05 12:55:53 2019 +0000
Branch:
MbedBMAGThrRev
Revision:
61:52a6d0ffd8e5
dato rettel og ID i file lagt ind i version 5

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gert_lauritsen 61:52a6d0ffd8e5 1 /* IUSBHostSerial.h */
gert_lauritsen 61:52a6d0ffd8e5 2 /* Copyright (c) 2010-2012 mbed.org, MIT License
gert_lauritsen 61:52a6d0ffd8e5 3 *
gert_lauritsen 61:52a6d0ffd8e5 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
gert_lauritsen 61:52a6d0ffd8e5 5 * and associated documentation files (the "Software"), to deal in the Software without
gert_lauritsen 61:52a6d0ffd8e5 6 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
gert_lauritsen 61:52a6d0ffd8e5 7 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
gert_lauritsen 61:52a6d0ffd8e5 8 * Software is furnished to do so, subject to the following conditions:
gert_lauritsen 61:52a6d0ffd8e5 9 *
gert_lauritsen 61:52a6d0ffd8e5 10 * The above copyright notice and this permission notice shall be included in all copies or
gert_lauritsen 61:52a6d0ffd8e5 11 * substantial portions of the Software.
gert_lauritsen 61:52a6d0ffd8e5 12 *
gert_lauritsen 61:52a6d0ffd8e5 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
gert_lauritsen 61:52a6d0ffd8e5 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
gert_lauritsen 61:52a6d0ffd8e5 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
gert_lauritsen 61:52a6d0ffd8e5 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
gert_lauritsen 61:52a6d0ffd8e5 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
gert_lauritsen 61:52a6d0ffd8e5 18 */
gert_lauritsen 61:52a6d0ffd8e5 19
gert_lauritsen 61:52a6d0ffd8e5 20 #ifndef IUSBHOSTSERIAL_H_
gert_lauritsen 61:52a6d0ffd8e5 21 #define IUSBHOSTSERIAL_H_
gert_lauritsen 61:52a6d0ffd8e5 22
gert_lauritsen 61:52a6d0ffd8e5 23 /**
gert_lauritsen 61:52a6d0ffd8e5 24 * Generic interface to abstract 3G dongles' impl
gert_lauritsen 61:52a6d0ffd8e5 25 */
gert_lauritsen 61:52a6d0ffd8e5 26
gert_lauritsen 61:52a6d0ffd8e5 27 #include "USBHostConf.h"
gert_lauritsen 61:52a6d0ffd8e5 28
gert_lauritsen 61:52a6d0ffd8e5 29 #ifdef USBHOST_3GMODULE
gert_lauritsen 61:52a6d0ffd8e5 30
gert_lauritsen 61:52a6d0ffd8e5 31 #include "IUSBHostSerialListener.h"
gert_lauritsen 61:52a6d0ffd8e5 32
gert_lauritsen 61:52a6d0ffd8e5 33 // This is needed by some versions of GCC
gert_lauritsen 61:52a6d0ffd8e5 34 #undef putc
gert_lauritsen 61:52a6d0ffd8e5 35 #undef getc
gert_lauritsen 61:52a6d0ffd8e5 36
gert_lauritsen 61:52a6d0ffd8e5 37 class IUSBHostSerial {
gert_lauritsen 61:52a6d0ffd8e5 38 public:
gert_lauritsen 61:52a6d0ffd8e5 39
gert_lauritsen 61:52a6d0ffd8e5 40 enum IrqType {
gert_lauritsen 61:52a6d0ffd8e5 41 RxIrq,
gert_lauritsen 61:52a6d0ffd8e5 42 TxIrq
gert_lauritsen 61:52a6d0ffd8e5 43 };
gert_lauritsen 61:52a6d0ffd8e5 44
gert_lauritsen 61:52a6d0ffd8e5 45 /*
gert_lauritsen 61:52a6d0ffd8e5 46 * Get a char from the dongle's serial interface
gert_lauritsen 61:52a6d0ffd8e5 47 */
gert_lauritsen 61:52a6d0ffd8e5 48 virtual int getc() = 0;
gert_lauritsen 61:52a6d0ffd8e5 49
gert_lauritsen 61:52a6d0ffd8e5 50 /*
gert_lauritsen 61:52a6d0ffd8e5 51 * Put a char to the dongle's serial interface
gert_lauritsen 61:52a6d0ffd8e5 52 */
gert_lauritsen 61:52a6d0ffd8e5 53 virtual int putc(int c) = 0;
gert_lauritsen 61:52a6d0ffd8e5 54
gert_lauritsen 61:52a6d0ffd8e5 55 /*
gert_lauritsen 61:52a6d0ffd8e5 56 * Read a packet from the dongle's serial interface, to be called after multiple getc() calls
gert_lauritsen 61:52a6d0ffd8e5 57 */
gert_lauritsen 61:52a6d0ffd8e5 58 virtual int readPacket() = 0;
gert_lauritsen 61:52a6d0ffd8e5 59
gert_lauritsen 61:52a6d0ffd8e5 60 /*
gert_lauritsen 61:52a6d0ffd8e5 61 * Write a packet to the dongle's serial interface, to be called after multiple putc() calls
gert_lauritsen 61:52a6d0ffd8e5 62 */
gert_lauritsen 61:52a6d0ffd8e5 63 virtual int writePacket() = 0;
gert_lauritsen 61:52a6d0ffd8e5 64
gert_lauritsen 61:52a6d0ffd8e5 65 /**
gert_lauritsen 61:52a6d0ffd8e5 66 * Check the number of bytes available.
gert_lauritsen 61:52a6d0ffd8e5 67 *
gert_lauritsen 61:52a6d0ffd8e5 68 * @returns the number of bytes available
gert_lauritsen 61:52a6d0ffd8e5 69 */
gert_lauritsen 61:52a6d0ffd8e5 70 virtual int readable() = 0;
gert_lauritsen 61:52a6d0ffd8e5 71
gert_lauritsen 61:52a6d0ffd8e5 72 /**
gert_lauritsen 61:52a6d0ffd8e5 73 * Check the free space in output.
gert_lauritsen 61:52a6d0ffd8e5 74 *
gert_lauritsen 61:52a6d0ffd8e5 75 * @returns the number of bytes available
gert_lauritsen 61:52a6d0ffd8e5 76 */
gert_lauritsen 61:52a6d0ffd8e5 77 virtual int writeable() = 0;
gert_lauritsen 61:52a6d0ffd8e5 78
gert_lauritsen 61:52a6d0ffd8e5 79 /**
gert_lauritsen 61:52a6d0ffd8e5 80 * Attach a handler to call when a packet is received / when a packet has been transmitted.
gert_lauritsen 61:52a6d0ffd8e5 81 *
gert_lauritsen 61:52a6d0ffd8e5 82 * @param pListener instance of the listener deriving from the IUSBHostSerialListener
gert_lauritsen 61:52a6d0ffd8e5 83 */
gert_lauritsen 61:52a6d0ffd8e5 84 virtual void attach(IUSBHostSerialListener* pListener) = 0;
gert_lauritsen 61:52a6d0ffd8e5 85
gert_lauritsen 61:52a6d0ffd8e5 86 /**
gert_lauritsen 61:52a6d0ffd8e5 87 * Enable or disable readable/writeable callbacks
gert_lauritsen 61:52a6d0ffd8e5 88 */
gert_lauritsen 61:52a6d0ffd8e5 89 virtual void setupIrq(bool en, IrqType irq = RxIrq) = 0;
gert_lauritsen 61:52a6d0ffd8e5 90
gert_lauritsen 61:52a6d0ffd8e5 91 };
gert_lauritsen 61:52a6d0ffd8e5 92
gert_lauritsen 61:52a6d0ffd8e5 93 #endif /* USBHOST_3GMODULE */
gert_lauritsen 61:52a6d0ffd8e5 94
gert_lauritsen 61:52a6d0ffd8e5 95 #endif /* IUSBHOSTSERIAL_H_ */