Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/PortOut.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

UserRevisionLine numberNew contents of line
aravindsv 0:ba7650f404af 1 /* mbed Microcontroller Library
aravindsv 0:ba7650f404af 2 * Copyright (c) 2006-2013 ARM Limited
aravindsv 0:ba7650f404af 3 *
aravindsv 0:ba7650f404af 4 * Licensed under the Apache License, Version 2.0 (the "License");
aravindsv 0:ba7650f404af 5 * you may not use this file except in compliance with the License.
aravindsv 0:ba7650f404af 6 * You may obtain a copy of the License at
aravindsv 0:ba7650f404af 7 *
aravindsv 0:ba7650f404af 8 * http://www.apache.org/licenses/LICENSE-2.0
aravindsv 0:ba7650f404af 9 *
aravindsv 0:ba7650f404af 10 * Unless required by applicable law or agreed to in writing, software
aravindsv 0:ba7650f404af 11 * distributed under the License is distributed on an "AS IS" BASIS,
aravindsv 0:ba7650f404af 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
aravindsv 0:ba7650f404af 13 * See the License for the specific language governing permissions and
aravindsv 0:ba7650f404af 14 * limitations under the License.
aravindsv 0:ba7650f404af 15 */
aravindsv 0:ba7650f404af 16 #ifndef MBED_PORTOUT_H
aravindsv 0:ba7650f404af 17 #define MBED_PORTOUT_H
aravindsv 0:ba7650f404af 18
aravindsv 0:ba7650f404af 19 #include "platform.h"
aravindsv 0:ba7650f404af 20
aravindsv 0:ba7650f404af 21 #if DEVICE_PORTOUT
aravindsv 0:ba7650f404af 22
aravindsv 0:ba7650f404af 23 #include "port_api.h"
aravindsv 0:ba7650f404af 24
aravindsv 0:ba7650f404af 25 namespace mbed {
aravindsv 0:ba7650f404af 26 /** A multiple pin digital out
aravindsv 0:ba7650f404af 27 *
aravindsv 0:ba7650f404af 28 * Example:
aravindsv 0:ba7650f404af 29 * @code
aravindsv 0:ba7650f404af 30 * // Toggle all four LEDs
aravindsv 0:ba7650f404af 31 *
aravindsv 0:ba7650f404af 32 * #include "mbed.h"
aravindsv 0:ba7650f404af 33 *
aravindsv 0:ba7650f404af 34 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
aravindsv 0:ba7650f404af 35 * #define LED_MASK 0x00B40000
aravindsv 0:ba7650f404af 36 *
aravindsv 0:ba7650f404af 37 * PortOut ledport(Port1, LED_MASK);
aravindsv 0:ba7650f404af 38 *
aravindsv 0:ba7650f404af 39 * int main() {
aravindsv 0:ba7650f404af 40 * while(1) {
aravindsv 0:ba7650f404af 41 * ledport = LED_MASK;
aravindsv 0:ba7650f404af 42 * wait(1);
aravindsv 0:ba7650f404af 43 * ledport = 0;
aravindsv 0:ba7650f404af 44 * wait(1);
aravindsv 0:ba7650f404af 45 * }
aravindsv 0:ba7650f404af 46 * }
aravindsv 0:ba7650f404af 47 * @endcode
aravindsv 0:ba7650f404af 48 */
aravindsv 0:ba7650f404af 49 class PortOut {
aravindsv 0:ba7650f404af 50 public:
aravindsv 0:ba7650f404af 51
aravindsv 0:ba7650f404af 52 /** Create an PortOut, connected to the specified port
aravindsv 0:ba7650f404af 53 *
aravindsv 0:ba7650f404af 54 * @param port Port to connect to (Port0-Port5)
aravindsv 0:ba7650f404af 55 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
aravindsv 0:ba7650f404af 56 */
aravindsv 0:ba7650f404af 57 PortOut(PortName port, int mask = 0xFFFFFFFF) {
aravindsv 0:ba7650f404af 58 port_init(&_port, port, mask, PIN_OUTPUT);
aravindsv 0:ba7650f404af 59 }
aravindsv 0:ba7650f404af 60
aravindsv 0:ba7650f404af 61 /** Write the value to the output port
aravindsv 0:ba7650f404af 62 *
aravindsv 0:ba7650f404af 63 * @param value An integer specifying a bit to write for every corresponding PortOut pin
aravindsv 0:ba7650f404af 64 */
aravindsv 0:ba7650f404af 65 void write(int value) {
aravindsv 0:ba7650f404af 66 port_write(&_port, value);
aravindsv 0:ba7650f404af 67 }
aravindsv 0:ba7650f404af 68
aravindsv 0:ba7650f404af 69 /** Read the value currently output on the port
aravindsv 0:ba7650f404af 70 *
aravindsv 0:ba7650f404af 71 * @returns
aravindsv 0:ba7650f404af 72 * An integer with each bit corresponding to associated PortOut pin setting
aravindsv 0:ba7650f404af 73 */
aravindsv 0:ba7650f404af 74 int read() {
aravindsv 0:ba7650f404af 75 return port_read(&_port);
aravindsv 0:ba7650f404af 76 }
aravindsv 0:ba7650f404af 77
aravindsv 0:ba7650f404af 78 /** A shorthand for write()
aravindsv 0:ba7650f404af 79 */
aravindsv 0:ba7650f404af 80 PortOut& operator= (int value) {
aravindsv 0:ba7650f404af 81 write(value);
aravindsv 0:ba7650f404af 82 return *this;
aravindsv 0:ba7650f404af 83 }
aravindsv 0:ba7650f404af 84
aravindsv 0:ba7650f404af 85 PortOut& operator= (PortOut& rhs) {
aravindsv 0:ba7650f404af 86 write(rhs.read());
aravindsv 0:ba7650f404af 87 return *this;
aravindsv 0:ba7650f404af 88 }
aravindsv 0:ba7650f404af 89
aravindsv 0:ba7650f404af 90 /** A shorthand for read()
aravindsv 0:ba7650f404af 91 */
aravindsv 0:ba7650f404af 92 operator int() {
aravindsv 0:ba7650f404af 93 return read();
aravindsv 0:ba7650f404af 94 }
aravindsv 0:ba7650f404af 95
aravindsv 0:ba7650f404af 96 private:
aravindsv 0:ba7650f404af 97 port_t _port;
aravindsv 0:ba7650f404af 98 };
aravindsv 0:ba7650f404af 99
aravindsv 0:ba7650f404af 100 } // namespace mbed
aravindsv 0:ba7650f404af 101
aravindsv 0:ba7650f404af 102 #endif
aravindsv 0:ba7650f404af 103
aravindsv 0:ba7650f404af 104 #endif