Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

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