Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/mbed-dev-bin/PortIn.h@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

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