Bei Chen Liu / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/PortIn.h@9:0ce32e54c9a7, 2013-06-10 (annotated)

Committer:
emilmont
Date:
Mon Jun 10 16:03:00 2013 +0100
Revision:
9:0ce32e54c9a7
Parent:
cpp/PortIn.h@2:143cac498751
Child:
10:3bc89ef62ce7
Refactoring of the mbed SDK:

- Provide a well defined HAL and API

- Keep separated the HAL implementations for the different targets

Who changed what in which revision?

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