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/PortIn.h@1:ebce2ad32f95, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 03:07:12 2015 +0000
Revision:
1:ebce2ad32f95
Parent:
0:ba7650f404af 
Changed the RCC timeout value to 500 ms, so total code startup time before program starts running is ~1s. Hopefully no side-effects from lower startup timeouts

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_PORTIN_H
aravindsv 0:ba7650f404af 17 #define MBED_PORTIN_H
aravindsv 0:ba7650f404af 18
aravindsv 0:ba7650f404af 19 #include "platform.h"
aravindsv 0:ba7650f404af 20
aravindsv 0:ba7650f404af 21 #if DEVICE_PORTIN
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
aravindsv 0:ba7650f404af 27 /** A multiple pin digital input
aravindsv 0:ba7650f404af 28 *
aravindsv 0:ba7650f404af 29 * Example:
aravindsv 0:ba7650f404af 30 * @code
aravindsv 0:ba7650f404af 31 * // Switch on an LED if any of mbed pins 21-26 is high
aravindsv 0:ba7650f404af 32 *
aravindsv 0:ba7650f404af 33 * #include "mbed.h"
aravindsv 0:ba7650f404af 34 *
aravindsv 0:ba7650f404af 35 * PortIn p(Port2, 0x0000003F); // p21-p26
aravindsv 0:ba7650f404af 36 * DigitalOut ind(LED4);
aravindsv 0:ba7650f404af 37 *
aravindsv 0:ba7650f404af 38 * int main() {
aravindsv 0:ba7650f404af 39 * while(1) {
aravindsv 0:ba7650f404af 40 * int pins = p.read();
aravindsv 0:ba7650f404af 41 * if(pins) {
aravindsv 0:ba7650f404af 42 * ind = 1;
aravindsv 0:ba7650f404af 43 * } else {
aravindsv 0:ba7650f404af 44 * ind = 0;
aravindsv 0:ba7650f404af 45 * }
aravindsv 0:ba7650f404af 46 * }
aravindsv 0:ba7650f404af 47 * }
aravindsv 0:ba7650f404af 48 * @endcode
aravindsv 0:ba7650f404af 49 */
aravindsv 0:ba7650f404af 50 class PortIn {
aravindsv 0:ba7650f404af 51 public:
aravindsv 0:ba7650f404af 52
aravindsv 0:ba7650f404af 53 /** Create an PortIn, connected to the specified port
aravindsv 0:ba7650f404af 54 *
aravindsv 0:ba7650f404af 55 * @param port Port to connect to (Port0-Port5)
aravindsv 0:ba7650f404af 56 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
aravindsv 0:ba7650f404af 57 */
aravindsv 0:ba7650f404af 58 PortIn(PortName port, int mask = 0xFFFFFFFF) {
aravindsv 0:ba7650f404af 59 port_init(&_port, port, mask, PIN_INPUT);
aravindsv 0:ba7650f404af 60 }
aravindsv 0:ba7650f404af 61
aravindsv 0:ba7650f404af 62 /** Read the value currently output on the port
aravindsv 0:ba7650f404af 63 *
aravindsv 0:ba7650f404af 64 * @returns
aravindsv 0:ba7650f404af 65 * An integer with each bit corresponding to associated port pin setting
aravindsv 0:ba7650f404af 66 */
aravindsv 0:ba7650f404af 67 int read() {
aravindsv 0:ba7650f404af 68 return port_read(&_port);
aravindsv 0:ba7650f404af 69 }
aravindsv 0:ba7650f404af 70
aravindsv 0:ba7650f404af 71 /** Set the input pin mode
aravindsv 0:ba7650f404af 72 *
aravindsv 0:ba7650f404af 73 * @param mode PullUp, PullDown, PullNone, OpenDrain
aravindsv 0:ba7650f404af 74 */
aravindsv 0:ba7650f404af 75 void mode(PinMode mode) {
aravindsv 0:ba7650f404af 76 port_mode(&_port, mode);
aravindsv 0:ba7650f404af 77 }
aravindsv 0:ba7650f404af 78
aravindsv 0:ba7650f404af 79 /** A shorthand for read()
aravindsv 0:ba7650f404af 80 */
aravindsv 0:ba7650f404af 81 operator int() {
aravindsv 0:ba7650f404af 82 return read();
aravindsv 0:ba7650f404af 83 }
aravindsv 0:ba7650f404af 84
aravindsv 0:ba7650f404af 85 private:
aravindsv 0:ba7650f404af 86 port_t _port;
aravindsv 0:ba7650f404af 87 };
aravindsv 0:ba7650f404af 88
aravindsv 0:ba7650f404af 89 } // namespace mbed
aravindsv 0:ba7650f404af 90
aravindsv 0:ba7650f404af 91 #endif
aravindsv 0:ba7650f404af 92
aravindsv 0:ba7650f404af 93 #endif