Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

PortIn.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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