modtronix H / mbed_nz32sc151

mbed library for NZ32-SC151

api/PortIn.h@17:639ed60ce759, 2016-08-19 (annotated)

Committer:
modtronix-com
Date:
Fri Aug 19 15:46:42 2016 +1000
Revision:
17:639ed60ce759
Parent:
1:71204b8406f2 
Added tag v1.1 for changeset 076cbe3e55be

Who changed what in which revision?

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