spinal cord / PokittoLib_

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

mbed-pokitto/api/RawSerial.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_RAW_SERIAL_H
Pokitto 5:ea7377f3d1af 17 #define MBED_RAW_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 "SerialBase.h"
Pokitto 5:ea7377f3d1af 24 #include "serial_api.h"
Pokitto 5:ea7377f3d1af 25
Pokitto 5:ea7377f3d1af 26 namespace mbed {
Pokitto 5:ea7377f3d1af 27
Pokitto 5:ea7377f3d1af 28 /** A serial port (UART) for communication with other serial devices
Pokitto 5:ea7377f3d1af 29 * This is a variation of the Serial class that doesn't use streams,
Pokitto 5:ea7377f3d1af 30 * thus making it safe to use in interrupt handlers with the RTOS.
Pokitto 5:ea7377f3d1af 31 *
Pokitto 5:ea7377f3d1af 32 * Can be used for Full Duplex communication, or Simplex by specifying
Pokitto 5:ea7377f3d1af 33 * one pin as NC (Not Connected)
Pokitto 5:ea7377f3d1af 34 *
Pokitto 5:ea7377f3d1af 35 * Example:
Pokitto 5:ea7377f3d1af 36 * @code
Pokitto 5:ea7377f3d1af 37 * // Send a char to the PC
Pokitto 5:ea7377f3d1af 38 *
Pokitto 5:ea7377f3d1af 39 * #include "mbed.h"
Pokitto 5:ea7377f3d1af 40 *
Pokitto 5:ea7377f3d1af 41 * RawSerial pc(USBTX, USBRX);
Pokitto 5:ea7377f3d1af 42 *
Pokitto 5:ea7377f3d1af 43 * int main() {
Pokitto 5:ea7377f3d1af 44 * pc.putc('A');
Pokitto 5:ea7377f3d1af 45 * }
Pokitto 5:ea7377f3d1af 46 * @endcode
Pokitto 5:ea7377f3d1af 47 */
Pokitto 5:ea7377f3d1af 48 class RawSerial: public SerialBase {
Pokitto 5:ea7377f3d1af 49
Pokitto 5:ea7377f3d1af 50 public:
Pokitto 5:ea7377f3d1af 51 /** Create a RawSerial port, connected to the specified transmit and receive pins
Pokitto 5:ea7377f3d1af 52 *
Pokitto 5:ea7377f3d1af 53 * @param tx Transmit pin
Pokitto 5:ea7377f3d1af 54 * @param rx Receive pin
Pokitto 5:ea7377f3d1af 55 *
Pokitto 5:ea7377f3d1af 56 * @note
Pokitto 5:ea7377f3d1af 57 * Either tx or rx may be specified as NC if unused
Pokitto 5:ea7377f3d1af 58 */
Pokitto 5:ea7377f3d1af 59 RawSerial(PinName tx, PinName rx);
Pokitto 5:ea7377f3d1af 60
Pokitto 5:ea7377f3d1af 61 /** Write a char to the serial port
Pokitto 5:ea7377f3d1af 62 *
Pokitto 5:ea7377f3d1af 63 * @param c The char to write
Pokitto 5:ea7377f3d1af 64 *
Pokitto 5:ea7377f3d1af 65 * @returns The written char or -1 if an error occured
Pokitto 5:ea7377f3d1af 66 */
Pokitto 5:ea7377f3d1af 67 int putc(int c);
Pokitto 5:ea7377f3d1af 68
Pokitto 5:ea7377f3d1af 69 /** Read a char from the serial port
Pokitto 5:ea7377f3d1af 70 *
Pokitto 5:ea7377f3d1af 71 * @returns The char read from the serial port
Pokitto 5:ea7377f3d1af 72 */
Pokitto 5:ea7377f3d1af 73 int getc();
Pokitto 5:ea7377f3d1af 74
Pokitto 5:ea7377f3d1af 75 /** Write a string to the serial port
Pokitto 5:ea7377f3d1af 76 *
Pokitto 5:ea7377f3d1af 77 * @param str The string to write
Pokitto 5:ea7377f3d1af 78 *
Pokitto 5:ea7377f3d1af 79 * @returns 0 if the write succeeds, EOF for error
Pokitto 5:ea7377f3d1af 80 */
Pokitto 5:ea7377f3d1af 81 int puts(const char *str);
Pokitto 5:ea7377f3d1af 82
Pokitto 5:ea7377f3d1af 83 int printf(const char *format, ...);
Pokitto 5:ea7377f3d1af 84 };
Pokitto 5:ea7377f3d1af 85
Pokitto 5:ea7377f3d1af 86 } // namespace mbed
Pokitto 5:ea7377f3d1af 87
Pokitto 5:ea7377f3d1af 88 #endif
Pokitto 5:ea7377f3d1af 89
Pokitto 5:ea7377f3d1af 90 #endif