mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

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

Last commit 20 Feb 2019 by mbed official

api/PortOut.h@635:a11c0372f0ba, 2015-09-30 (annotated)

Committer:
mbed_official
Date:
Wed Sep 30 17:00:09 2015 +0100
Revision:
635:a11c0372f0ba
Parent:
13:0645d8841f51 
Synchronized with git revision d29c98dae61be0946ddf3a3c641c7726056f9452



Full URL: https://github.com/mbedmicro/mbed/commit/d29c98dae61be0946ddf3a3c641c7726056f9452/



Added support for SAMW25

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 13:0645d8841f51 1 /* mbed Microcontroller Library
bogdanm 13:0645d8841f51 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 13:0645d8841f51 3 *
bogdanm 13:0645d8841f51 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 13:0645d8841f51 5 * you may not use this file except in compliance with the License.
bogdanm 13:0645d8841f51 6 * You may obtain a copy of the License at
bogdanm 13:0645d8841f51 7 *
bogdanm 13:0645d8841f51 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 13:0645d8841f51 9 *
bogdanm 13:0645d8841f51 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 13:0645d8841f51 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 13:0645d8841f51 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 13:0645d8841f51 13 * See the License for the specific language governing permissions and
bogdanm 13:0645d8841f51 14 * limitations under the License.
bogdanm 13:0645d8841f51 15 */
bogdanm 13:0645d8841f51 16 #ifndef MBED_PORTOUT_H
bogdanm 13:0645d8841f51 17 #define MBED_PORTOUT_H
bogdanm 13:0645d8841f51 18
bogdanm 13:0645d8841f51 19 #include "platform.h"
bogdanm 13:0645d8841f51 20
bogdanm 13:0645d8841f51 21 #if DEVICE_PORTOUT
bogdanm 13:0645d8841f51 22
bogdanm 13:0645d8841f51 23 #include "port_api.h"
bogdanm 13:0645d8841f51 24
bogdanm 13:0645d8841f51 25 namespace mbed {
bogdanm 13:0645d8841f51 26 /** A multiple pin digital out
bogdanm 13:0645d8841f51 27 *
bogdanm 13:0645d8841f51 28 * Example:
bogdanm 13:0645d8841f51 29 * @code
bogdanm 13:0645d8841f51 30 * // Toggle all four LEDs
bogdanm 13:0645d8841f51 31 *
bogdanm 13:0645d8841f51 32 * #include "mbed.h"
bogdanm 13:0645d8841f51 33 *
bogdanm 13:0645d8841f51 34 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
bogdanm 13:0645d8841f51 35 * #define LED_MASK 0x00B40000
bogdanm 13:0645d8841f51 36 *
bogdanm 13:0645d8841f51 37 * PortOut ledport(Port1, LED_MASK);
bogdanm 13:0645d8841f51 38 *
bogdanm 13:0645d8841f51 39 * int main() {
bogdanm 13:0645d8841f51 40 * while(1) {
bogdanm 13:0645d8841f51 41 * ledport = LED_MASK;
bogdanm 13:0645d8841f51 42 * wait(1);
bogdanm 13:0645d8841f51 43 * ledport = 0;
bogdanm 13:0645d8841f51 44 * wait(1);
bogdanm 13:0645d8841f51 45 * }
bogdanm 13:0645d8841f51 46 * }
bogdanm 13:0645d8841f51 47 * @endcode
bogdanm 13:0645d8841f51 48 */
bogdanm 13:0645d8841f51 49 class PortOut {
bogdanm 13:0645d8841f51 50 public:
bogdanm 13:0645d8841f51 51
bogdanm 13:0645d8841f51 52 /** Create an PortOut, connected to the specified port
bogdanm 13:0645d8841f51 53 *
bogdanm 13:0645d8841f51 54 * @param port Port to connect to (Port0-Port5)
bogdanm 13:0645d8841f51 55 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
bogdanm 13:0645d8841f51 56 */
bogdanm 13:0645d8841f51 57 PortOut(PortName port, int mask = 0xFFFFFFFF) {
bogdanm 13:0645d8841f51 58 port_init(&_port, port, mask, PIN_OUTPUT);
bogdanm 13:0645d8841f51 59 }
bogdanm 13:0645d8841f51 60
bogdanm 13:0645d8841f51 61 /** Write the value to the output port
bogdanm 13:0645d8841f51 62 *
bogdanm 13:0645d8841f51 63 * @param value An integer specifying a bit to write for every corresponding PortOut pin
bogdanm 13:0645d8841f51 64 */
bogdanm 13:0645d8841f51 65 void write(int value) {
bogdanm 13:0645d8841f51 66 port_write(&_port, value);
bogdanm 13:0645d8841f51 67 }
bogdanm 13:0645d8841f51 68
bogdanm 13:0645d8841f51 69 /** Read the value currently output on the port
bogdanm 13:0645d8841f51 70 *
bogdanm 13:0645d8841f51 71 * @returns
bogdanm 13:0645d8841f51 72 * An integer with each bit corresponding to associated PortOut pin setting
bogdanm 13:0645d8841f51 73 */
bogdanm 13:0645d8841f51 74 int read() {
bogdanm 13:0645d8841f51 75 return port_read(&_port);
bogdanm 13:0645d8841f51 76 }
bogdanm 13:0645d8841f51 77
bogdanm 13:0645d8841f51 78 /** A shorthand for write()
bogdanm 13:0645d8841f51 79 */
bogdanm 13:0645d8841f51 80 PortOut& operator= (int value) {
bogdanm 13:0645d8841f51 81 write(value);
bogdanm 13:0645d8841f51 82 return *this;
bogdanm 13:0645d8841f51 83 }
bogdanm 13:0645d8841f51 84
bogdanm 13:0645d8841f51 85 PortOut& operator= (PortOut& rhs) {
bogdanm 13:0645d8841f51 86 write(rhs.read());
bogdanm 13:0645d8841f51 87 return *this;
bogdanm 13:0645d8841f51 88 }
bogdanm 13:0645d8841f51 89
bogdanm 13:0645d8841f51 90 /** A shorthand for read()
bogdanm 13:0645d8841f51 91 */
bogdanm 13:0645d8841f51 92 operator int() {
bogdanm 13:0645d8841f51 93 return read();
bogdanm 13:0645d8841f51 94 }
bogdanm 13:0645d8841f51 95
bogdanm 13:0645d8841f51 96 private:
bogdanm 13:0645d8841f51 97 port_t _port;
bogdanm 13:0645d8841f51 98 };
bogdanm 13:0645d8841f51 99
bogdanm 13:0645d8841f51 100 } // namespace mbed
bogdanm 13:0645d8841f51 101
bogdanm 13:0645d8841f51 102 #endif
bogdanm 13:0645d8841f51 103
bogdanm 13:0645d8841f51 104 #endif