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@9:0ce32e54c9a7, 2013-06-10 (annotated)

Committer:
emilmont
Date:
Mon Jun 10 16:03:00 2013 +0100
Revision:
9:0ce32e54c9a7
Parent:
cpp/PortOut.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_PORTOUT_H
mbed_official 0:fd0d7bdfcdc2 17 #define MBED_PORTOUT_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_PORTOUT
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 /** A multiple pin digital out
mbed_official 0:fd0d7bdfcdc2 27 *
mbed_official 0:fd0d7bdfcdc2 28 * Example:
mbed_official 0:fd0d7bdfcdc2 29 * @code
mbed_official 0:fd0d7bdfcdc2 30 * // Toggle all four LEDs
emilmont 2:143cac498751 31 *
mbed_official 0:fd0d7bdfcdc2 32 * #include "mbed.h"
mbed_official 0:fd0d7bdfcdc2 33 *
mbed_official 0:fd0d7bdfcdc2 34 * // LED1 = P1.18 LED2 = P1.20 LED3 = P1.21 LED4 = P1.23
mbed_official 0:fd0d7bdfcdc2 35 * #define LED_MASK 0x00B40000
mbed_official 0:fd0d7bdfcdc2 36 *
mbed_official 0:fd0d7bdfcdc2 37 * PortOut ledport(Port1, LED_MASK);
mbed_official 0:fd0d7bdfcdc2 38 *
mbed_official 0:fd0d7bdfcdc2 39 * int main() {
mbed_official 0:fd0d7bdfcdc2 40 * while(1) {
mbed_official 0:fd0d7bdfcdc2 41 * ledport = LED_MASK;
mbed_official 0:fd0d7bdfcdc2 42 * wait(1);
mbed_official 0:fd0d7bdfcdc2 43 * ledport = 0;
mbed_official 0:fd0d7bdfcdc2 44 * wait(1);
mbed_official 0:fd0d7bdfcdc2 45 * }
mbed_official 0:fd0d7bdfcdc2 46 * }
mbed_official 0:fd0d7bdfcdc2 47 * @endcode
emilmont 2:143cac498751 48 */
mbed_official 0:fd0d7bdfcdc2 49 class PortOut {
mbed_official 0:fd0d7bdfcdc2 50 public:
mbed_official 0:fd0d7bdfcdc2 51
mbed_official 0:fd0d7bdfcdc2 52 /** Create an PortOut, connected to the specified port
mbed_official 0:fd0d7bdfcdc2 53 *
mbed_official 0:fd0d7bdfcdc2 54 * @param port Port to connect to (Port0-Port5)
mbed_official 0:fd0d7bdfcdc2 55 * @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
emilmont 2:143cac498751 56 */
mbed_official 0:fd0d7bdfcdc2 57 PortOut(PortName port, int mask = 0xFFFFFFFF) {
mbed_official 0:fd0d7bdfcdc2 58 port_init(&_port, port, mask, PIN_OUTPUT);
mbed_official 0:fd0d7bdfcdc2 59 }
emilmont 2:143cac498751 60
mbed_official 0:fd0d7bdfcdc2 61 /** Write the value to the output port
mbed_official 0:fd0d7bdfcdc2 62 *
mbed_official 0:fd0d7bdfcdc2 63 * @param value An integer specifying a bit to write for every corresponding PortOut pin
emilmont 2:143cac498751 64 */
mbed_official 0:fd0d7bdfcdc2 65 void write(int value) {
mbed_official 0:fd0d7bdfcdc2 66 port_write(&_port, value);
mbed_official 0:fd0d7bdfcdc2 67 }
emilmont 2:143cac498751 68
mbed_official 0:fd0d7bdfcdc2 69 /** Read the value currently output on the port
mbed_official 0:fd0d7bdfcdc2 70 *
mbed_official 0:fd0d7bdfcdc2 71 * @returns
mbed_official 0:fd0d7bdfcdc2 72 * An integer with each bit corresponding to associated PortOut pin setting
mbed_official 0:fd0d7bdfcdc2 73 */
mbed_official 0:fd0d7bdfcdc2 74 int read() {
mbed_official 0:fd0d7bdfcdc2 75 return port_read(&_port);
mbed_official 0:fd0d7bdfcdc2 76 }
mbed_official 0:fd0d7bdfcdc2 77
mbed_official 0:fd0d7bdfcdc2 78 /** A shorthand for write()
emilmont 2:143cac498751 79 */
emilmont 2:143cac498751 80 PortOut& operator= (int value) {
mbed_official 0:fd0d7bdfcdc2 81 write(value);
mbed_official 0:fd0d7bdfcdc2 82 return *this;
mbed_official 0:fd0d7bdfcdc2 83 }
emilmont 2:143cac498751 84
emilmont 2:143cac498751 85 PortOut& operator= (PortOut& rhs) {
mbed_official 0:fd0d7bdfcdc2 86 write(rhs.read());
mbed_official 0:fd0d7bdfcdc2 87 return *this;
mbed_official 0:fd0d7bdfcdc2 88 }
emilmont 2:143cac498751 89
mbed_official 0:fd0d7bdfcdc2 90 /** A shorthand for read()
mbed_official 0:fd0d7bdfcdc2 91 */
emilmont 2:143cac498751 92 operator int() {
mbed_official 0:fd0d7bdfcdc2 93 return read();
mbed_official 0:fd0d7bdfcdc2 94 }
mbed_official 0:fd0d7bdfcdc2 95
mbed_official 0:fd0d7bdfcdc2 96 private:
mbed_official 0:fd0d7bdfcdc2 97 port_t _port;
mbed_official 0:fd0d7bdfcdc2 98 };
mbed_official 0:fd0d7bdfcdc2 99
mbed_official 0:fd0d7bdfcdc2 100 } // namespace mbed
mbed_official 0:fd0d7bdfcdc2 101
mbed_official 0:fd0d7bdfcdc2 102 #endif
mbed_official 0:fd0d7bdfcdc2 103
mbed_official 0:fd0d7bdfcdc2 104 #endif