Jhon Plantikow / mbed

.

Dependents:   RTC

PortIn.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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