Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/PortIn.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sinrab 0:5464d5e415e5 1 /* mbed Microcontroller Library
sinrab 0:5464d5e415e5 2 * Copyright (c) 2006-2013 ARM Limited
sinrab 0:5464d5e415e5 3 *
sinrab 0:5464d5e415e5 4 * Licensed under the Apache License, Version 2.0 (the "License");
sinrab 0:5464d5e415e5 5 * you may not use this file except in compliance with the License.
sinrab 0:5464d5e415e5 6 * You may obtain a copy of the License at
sinrab 0:5464d5e415e5 7 *
sinrab 0:5464d5e415e5 8 * http://www.apache.org/licenses/LICENSE-2.0
sinrab 0:5464d5e415e5 9 *
sinrab 0:5464d5e415e5 10 * Unless required by applicable law or agreed to in writing, software
sinrab 0:5464d5e415e5 11 * distributed under the License is distributed on an "AS IS" BASIS,
sinrab 0:5464d5e415e5 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sinrab 0:5464d5e415e5 13 * See the License for the specific language governing permissions and
sinrab 0:5464d5e415e5 14 * limitations under the License.
sinrab 0:5464d5e415e5 15 */
sinrab 0:5464d5e415e5 16 #ifndef MBED_PORTIN_H
sinrab 0:5464d5e415e5 17 #define MBED_PORTIN_H
sinrab 0:5464d5e415e5 18
sinrab 0:5464d5e415e5 19 #include "platform.h"
sinrab 0:5464d5e415e5 20
sinrab 0:5464d5e415e5 21 #if DEVICE_PORTIN
sinrab 0:5464d5e415e5 22
sinrab 0:5464d5e415e5 23 #include "port_api.h"
sinrab 0:5464d5e415e5 24
sinrab 0:5464d5e415e5 25 namespace mbed {
sinrab 0:5464d5e415e5 26
sinrab 0:5464d5e415e5 27 /** A multiple pin digital input
sinrab 0:5464d5e415e5 28 *
sinrab 0:5464d5e415e5 29 * Example:
sinrab 0:5464d5e415e5 30 * @code
sinrab 0:5464d5e415e5 31 * // Switch on an LED if any of mbed pins 21-26 is high
sinrab 0:5464d5e415e5 32 *
sinrab 0:5464d5e415e5 33 * #include "mbed.h"
sinrab 0:5464d5e415e5 34 *
sinrab 0:5464d5e415e5 35 * PortIn p(Port2, 0x0000003F); // p21-p26
sinrab 0:5464d5e415e5 36 * DigitalOut ind(LED4);
sinrab 0:5464d5e415e5 37 *
sinrab 0:5464d5e415e5 38 * int main() {
sinrab 0:5464d5e415e5 39 * while(1) {
sinrab 0:5464d5e415e5 40 * int pins = p.read();
sinrab 0:5464d5e415e5 41 * if(pins) {
sinrab 0:5464d5e415e5 42 * ind = 1;
sinrab 0:5464d5e415e5 43 * } else {
sinrab 0:5464d5e415e5 44 * ind = 0;
sinrab 0:5464d5e415e5 45 * }
sinrab 0:5464d5e415e5 46 * }
sinrab 0:5464d5e415e5 47 * }
sinrab 0:5464d5e415e5 48 * @endcode
sinrab 0:5464d5e415e5 49 */
sinrab 0:5464d5e415e5 50 class PortIn {
sinrab 0:5464d5e415e5 51 public:
sinrab 0:5464d5e415e5 52
sinrab 0:5464d5e415e5 53 /** Create an PortIn, connected to the specified port
sinrab 0:5464d5e415e5 54 *
sinrab 0:5464d5e415e5 55 * @param port Port to connect to (Port0-Port5)
sinrab 0:5464d5e415e5 56 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
sinrab 0:5464d5e415e5 57 */
sinrab 0:5464d5e415e5 58 PortIn(PortName port, int mask = 0xFFFFFFFF) {
sinrab 0:5464d5e415e5 59 port_init(&_port, port, mask, PIN_INPUT);
sinrab 0:5464d5e415e5 60 }
sinrab 0:5464d5e415e5 61
sinrab 0:5464d5e415e5 62 /** Read the value currently output on the port
sinrab 0:5464d5e415e5 63 *
sinrab 0:5464d5e415e5 64 * @returns
sinrab 0:5464d5e415e5 65 * An integer with each bit corresponding to associated port pin setting
sinrab 0:5464d5e415e5 66 */
sinrab 0:5464d5e415e5 67 int read() {
sinrab 0:5464d5e415e5 68 return port_read(&_port);
sinrab 0:5464d5e415e5 69 }
sinrab 0:5464d5e415e5 70
sinrab 0:5464d5e415e5 71 /** Set the input pin mode
sinrab 0:5464d5e415e5 72 *
sinrab 0:5464d5e415e5 73 * @param mode PullUp, PullDown, PullNone, OpenDrain
sinrab 0:5464d5e415e5 74 */
sinrab 0:5464d5e415e5 75 void mode(PinMode mode) {
sinrab 0:5464d5e415e5 76 port_mode(&_port, mode);
sinrab 0:5464d5e415e5 77 }
sinrab 0:5464d5e415e5 78
sinrab 0:5464d5e415e5 79 /** A shorthand for read()
sinrab 0:5464d5e415e5 80 */
sinrab 0:5464d5e415e5 81 operator int() {
sinrab 0:5464d5e415e5 82 return read();
sinrab 0:5464d5e415e5 83 }
sinrab 0:5464d5e415e5 84
sinrab 0:5464d5e415e5 85 private:
sinrab 0:5464d5e415e5 86 port_t _port;
sinrab 0:5464d5e415e5 87 };
sinrab 0:5464d5e415e5 88
sinrab 0:5464d5e415e5 89 } // namespace mbed
sinrab 0:5464d5e415e5 90
sinrab 0:5464d5e415e5 91 #endif
sinrab 0:5464d5e415e5 92
sinrab 0:5464d5e415e5 93 #endif
sinrab 0:5464d5e415e5 94