spinal cord / PokittoLib_

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

mbed-pokitto/api/Serial.h@5:ea7377f3d1af, 2017-10-11 (annotated)

Committer:
Pokitto
Date:
Wed Oct 11 20:35:27 2017 +0000
Revision:
5:ea7377f3d1af
Fixed PokittoLib. Includes a working custom mbed-src

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Pokitto 5:ea7377f3d1af 1 /* mbed Microcontroller Library
Pokitto 5:ea7377f3d1af 2 * Copyright (c) 2006-2013 ARM Limited
Pokitto 5:ea7377f3d1af 3 *
Pokitto 5:ea7377f3d1af 4 * Licensed under the Apache License, Version 2.0 (the "License");
Pokitto 5:ea7377f3d1af 5 * you may not use this file except in compliance with the License.
Pokitto 5:ea7377f3d1af 6 * You may obtain a copy of the License at
Pokitto 5:ea7377f3d1af 7 *
Pokitto 5:ea7377f3d1af 8 * http://www.apache.org/licenses/LICENSE-2.0
Pokitto 5:ea7377f3d1af 9 *
Pokitto 5:ea7377f3d1af 10 * Unless required by applicable law or agreed to in writing, software
Pokitto 5:ea7377f3d1af 11 * distributed under the License is distributed on an "AS IS" BASIS,
Pokitto 5:ea7377f3d1af 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Pokitto 5:ea7377f3d1af 13 * See the License for the specific language governing permissions and
Pokitto 5:ea7377f3d1af 14 * limitations under the License.
Pokitto 5:ea7377f3d1af 15 */
Pokitto 5:ea7377f3d1af 16 #ifndef MBED_SERIAL_H
Pokitto 5:ea7377f3d1af 17 #define MBED_SERIAL_H
Pokitto 5:ea7377f3d1af 18
Pokitto 5:ea7377f3d1af 19 #include "platform.h"
Pokitto 5:ea7377f3d1af 20
Pokitto 5:ea7377f3d1af 21 #if DEVICE_SERIAL
Pokitto 5:ea7377f3d1af 22
Pokitto 5:ea7377f3d1af 23 #include "Stream.h"
Pokitto 5:ea7377f3d1af 24 #include "SerialBase.h"
Pokitto 5:ea7377f3d1af 25 #include "serial_api.h"
Pokitto 5:ea7377f3d1af 26
Pokitto 5:ea7377f3d1af 27 namespace mbed {
Pokitto 5:ea7377f3d1af 28
Pokitto 5:ea7377f3d1af 29 /** A serial port (UART) for communication with other serial devices
Pokitto 5:ea7377f3d1af 30 *
Pokitto 5:ea7377f3d1af 31 * Can be used for Full Duplex communication, or Simplex by specifying
Pokitto 5:ea7377f3d1af 32 * one pin as NC (Not Connected)
Pokitto 5:ea7377f3d1af 33 *
Pokitto 5:ea7377f3d1af 34 * Example:
Pokitto 5:ea7377f3d1af 35 * @code
Pokitto 5:ea7377f3d1af 36 * // Print "Hello World" to the PC
Pokitto 5:ea7377f3d1af 37 *
Pokitto 5:ea7377f3d1af 38 * #include "mbed.h"
Pokitto 5:ea7377f3d1af 39 *
Pokitto 5:ea7377f3d1af 40 * Serial pc(USBTX, USBRX);
Pokitto 5:ea7377f3d1af 41 *
Pokitto 5:ea7377f3d1af 42 * int main() {
Pokitto 5:ea7377f3d1af 43 * pc.printf("Hello World\n");
Pokitto 5:ea7377f3d1af 44 * }
Pokitto 5:ea7377f3d1af 45 * @endcode
Pokitto 5:ea7377f3d1af 46 */
Pokitto 5:ea7377f3d1af 47 class Serial : public SerialBase, public Stream {
Pokitto 5:ea7377f3d1af 48
Pokitto 5:ea7377f3d1af 49 public:
Pokitto 5:ea7377f3d1af 50 #if DEVICE_SERIAL_ASYNCH
Pokitto 5:ea7377f3d1af 51 using SerialBase::read;
Pokitto 5:ea7377f3d1af 52 using SerialBase::write;
Pokitto 5:ea7377f3d1af 53 #endif
Pokitto 5:ea7377f3d1af 54
Pokitto 5:ea7377f3d1af 55 /** Create a Serial port, connected to the specified transmit and receive pins
Pokitto 5:ea7377f3d1af 56 *
Pokitto 5:ea7377f3d1af 57 * @param tx Transmit pin
Pokitto 5:ea7377f3d1af 58 * @param rx Receive pin
Pokitto 5:ea7377f3d1af 59 *
Pokitto 5:ea7377f3d1af 60 * @note
Pokitto 5:ea7377f3d1af 61 * Either tx or rx may be specified as NC if unused
Pokitto 5:ea7377f3d1af 62 */
Pokitto 5:ea7377f3d1af 63 Serial(PinName tx, PinName rx, const char *name=NULL);
Pokitto 5:ea7377f3d1af 64
Pokitto 5:ea7377f3d1af 65 protected:
Pokitto 5:ea7377f3d1af 66 virtual int _getc();
Pokitto 5:ea7377f3d1af 67 virtual int _putc(int c);
Pokitto 5:ea7377f3d1af 68 };
Pokitto 5:ea7377f3d1af 69
Pokitto 5:ea7377f3d1af 70 } // namespace mbed
Pokitto 5:ea7377f3d1af 71
Pokitto 5:ea7377f3d1af 72 #endif
Pokitto 5:ea7377f3d1af 73
Pokitto 5:ea7377f3d1af 74 #endif