Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/PortIn.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

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