Alessandro Angelino / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/PortIn.h@4:473d4af53300, 2016-04-04 (annotated)

Committer:
Alessandro Angelino
Date:
Mon Apr 04 14:24:07 2016 +0100
Revision:
4:473d4af53300
Parent:
0:9c59db1fbc9e 
Fix function to get sp when in unprivileged mode

Who changed what in which revision?

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