mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

PortIn.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
65:5798e58a58b1 
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

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