Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

drivers/RawSerial.h@3:1198227e6421, 2016-12-16 (annotated)

Committer:
switches
Date:
Fri Dec 16 16:27:57 2016 +0000
Revision:
3:1198227e6421
Parent:
0:5c4d7b2438d3 
Changed ADC scale for MAX32625 platforms to 1.2V full scale to match MAX32630 platforms

Who changed what in which revision?

UserRevisionLine numberNew contents of line
switches 0:5c4d7b2438d3 1 /* mbed Microcontroller Library
switches 0:5c4d7b2438d3 2 * Copyright (c) 2006-2013 ARM Limited
switches 0:5c4d7b2438d3 3 *
switches 0:5c4d7b2438d3 4 * Licensed under the Apache License, Version 2.0 (the "License");
switches 0:5c4d7b2438d3 5 * you may not use this file except in compliance with the License.
switches 0:5c4d7b2438d3 6 * You may obtain a copy of the License at
switches 0:5c4d7b2438d3 7 *
switches 0:5c4d7b2438d3 8 * http://www.apache.org/licenses/LICENSE-2.0
switches 0:5c4d7b2438d3 9 *
switches 0:5c4d7b2438d3 10 * Unless required by applicable law or agreed to in writing, software
switches 0:5c4d7b2438d3 11 * distributed under the License is distributed on an "AS IS" BASIS,
switches 0:5c4d7b2438d3 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
switches 0:5c4d7b2438d3 13 * See the License for the specific language governing permissions and
switches 0:5c4d7b2438d3 14 * limitations under the License.
switches 0:5c4d7b2438d3 15 */
switches 0:5c4d7b2438d3 16 #ifndef MBED_RAW_SERIAL_H
switches 0:5c4d7b2438d3 17 #define MBED_RAW_SERIAL_H
switches 0:5c4d7b2438d3 18
switches 0:5c4d7b2438d3 19 #include "platform/platform.h"
switches 0:5c4d7b2438d3 20
switches 0:5c4d7b2438d3 21 #if DEVICE_SERIAL
switches 0:5c4d7b2438d3 22
switches 0:5c4d7b2438d3 23 #include "drivers/SerialBase.h"
switches 0:5c4d7b2438d3 24 #include "hal/serial_api.h"
switches 0:5c4d7b2438d3 25
switches 0:5c4d7b2438d3 26 namespace mbed {
switches 0:5c4d7b2438d3 27 /** \addtogroup drivers */
switches 0:5c4d7b2438d3 28 /** @{*/
switches 0:5c4d7b2438d3 29
switches 0:5c4d7b2438d3 30 /** A serial port (UART) for communication with other serial devices
switches 0:5c4d7b2438d3 31 * This is a variation of the Serial class that doesn't use streams,
switches 0:5c4d7b2438d3 32 * thus making it safe to use in interrupt handlers with the RTOS.
switches 0:5c4d7b2438d3 33 *
switches 0:5c4d7b2438d3 34 * Can be used for Full Duplex communication, or Simplex by specifying
switches 0:5c4d7b2438d3 35 * one pin as NC (Not Connected)
switches 0:5c4d7b2438d3 36 *
switches 0:5c4d7b2438d3 37 * @Note Synchronization level: Not protected
switches 0:5c4d7b2438d3 38 *
switches 0:5c4d7b2438d3 39 * Example:
switches 0:5c4d7b2438d3 40 * @code
switches 0:5c4d7b2438d3 41 * // Send a char to the PC
switches 0:5c4d7b2438d3 42 *
switches 0:5c4d7b2438d3 43 * #include "mbed.h"
switches 0:5c4d7b2438d3 44 *
switches 0:5c4d7b2438d3 45 * RawSerial pc(USBTX, USBRX);
switches 0:5c4d7b2438d3 46 *
switches 0:5c4d7b2438d3 47 * int main() {
switches 0:5c4d7b2438d3 48 * pc.putc('A');
switches 0:5c4d7b2438d3 49 * }
switches 0:5c4d7b2438d3 50 * @endcode
switches 0:5c4d7b2438d3 51 */
switches 0:5c4d7b2438d3 52 class RawSerial: public SerialBase {
switches 0:5c4d7b2438d3 53
switches 0:5c4d7b2438d3 54 public:
switches 0:5c4d7b2438d3 55 /** Create a RawSerial port, connected to the specified transmit and receive pins, with the specified baud.
switches 0:5c4d7b2438d3 56 *
switches 0:5c4d7b2438d3 57 * @param tx Transmit pin
switches 0:5c4d7b2438d3 58 * @param rx Receive pin
switches 0:5c4d7b2438d3 59 * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
switches 0:5c4d7b2438d3 60 *
switches 0:5c4d7b2438d3 61 * @note
switches 0:5c4d7b2438d3 62 * Either tx or rx may be specified as NC if unused
switches 0:5c4d7b2438d3 63 */
switches 0:5c4d7b2438d3 64 RawSerial(PinName tx, PinName rx, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
switches 0:5c4d7b2438d3 65
switches 0:5c4d7b2438d3 66 /** Write a char to the serial port
switches 0:5c4d7b2438d3 67 *
switches 0:5c4d7b2438d3 68 * @param c The char to write
switches 0:5c4d7b2438d3 69 *
switches 0:5c4d7b2438d3 70 * @returns The written char or -1 if an error occured
switches 0:5c4d7b2438d3 71 */
switches 0:5c4d7b2438d3 72 int putc(int c);
switches 0:5c4d7b2438d3 73
switches 0:5c4d7b2438d3 74 /** Read a char from the serial port
switches 0:5c4d7b2438d3 75 *
switches 0:5c4d7b2438d3 76 * @returns The char read from the serial port
switches 0:5c4d7b2438d3 77 */
switches 0:5c4d7b2438d3 78 int getc();
switches 0:5c4d7b2438d3 79
switches 0:5c4d7b2438d3 80 /** Write a string to the serial port
switches 0:5c4d7b2438d3 81 *
switches 0:5c4d7b2438d3 82 * @param str The string to write
switches 0:5c4d7b2438d3 83 *
switches 0:5c4d7b2438d3 84 * @returns 0 if the write succeeds, EOF for error
switches 0:5c4d7b2438d3 85 */
switches 0:5c4d7b2438d3 86 int puts(const char *str);
switches 0:5c4d7b2438d3 87
switches 0:5c4d7b2438d3 88 int printf(const char *format, ...);
switches 0:5c4d7b2438d3 89
switches 0:5c4d7b2438d3 90 protected:
switches 0:5c4d7b2438d3 91
switches 0:5c4d7b2438d3 92 /** Acquire exclusive access to this serial port
switches 0:5c4d7b2438d3 93 */
switches 0:5c4d7b2438d3 94 virtual void lock(void);
switches 0:5c4d7b2438d3 95
switches 0:5c4d7b2438d3 96 /** Release exclusive access to this serial port
switches 0:5c4d7b2438d3 97 */
switches 0:5c4d7b2438d3 98 virtual void unlock(void);
switches 0:5c4d7b2438d3 99 };
switches 0:5c4d7b2438d3 100
switches 0:5c4d7b2438d3 101 } // namespace mbed
switches 0:5c4d7b2438d3 102
switches 0:5c4d7b2438d3 103 #endif
switches 0:5c4d7b2438d3 104
switches 0:5c4d7b2438d3 105 #endif
switches 0:5c4d7b2438d3 106
switches 0:5c4d7b2438d3 107 /** @}*/