Kenji Arai / mbed-os_TYBLE16

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.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

drivers/PortOut.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

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