Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/hal/port_api.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ommpy 0:d383e2dee0f7 1
ommpy 0:d383e2dee0f7 2 /** \addtogroup hal */
ommpy 0:d383e2dee0f7 3 /** @{*/
ommpy 0:d383e2dee0f7 4 /* mbed Microcontroller Library
ommpy 0:d383e2dee0f7 5 * Copyright (c) 2006-2013 ARM Limited
ommpy 0:d383e2dee0f7 6 * SPDX-License-Identifier: Apache-2.0
ommpy 0:d383e2dee0f7 7 *
ommpy 0:d383e2dee0f7 8 * Licensed under the Apache License, Version 2.0 (the "License");
ommpy 0:d383e2dee0f7 9 * you may not use this file except in compliance with the License.
ommpy 0:d383e2dee0f7 10 * You may obtain a copy of the License at
ommpy 0:d383e2dee0f7 11 *
ommpy 0:d383e2dee0f7 12 * http://www.apache.org/licenses/LICENSE-2.0
ommpy 0:d383e2dee0f7 13 *
ommpy 0:d383e2dee0f7 14 * Unless required by applicable law or agreed to in writing, software
ommpy 0:d383e2dee0f7 15 * distributed under the License is distributed on an "AS IS" BASIS,
ommpy 0:d383e2dee0f7 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ommpy 0:d383e2dee0f7 17 * See the License for the specific language governing permissions and
ommpy 0:d383e2dee0f7 18 * limitations under the License.
ommpy 0:d383e2dee0f7 19 */
ommpy 0:d383e2dee0f7 20 #ifndef MBED_PORTMAP_H
ommpy 0:d383e2dee0f7 21 #define MBED_PORTMAP_H
ommpy 0:d383e2dee0f7 22
ommpy 0:d383e2dee0f7 23 #include "device.h"
ommpy 0:d383e2dee0f7 24
ommpy 0:d383e2dee0f7 25 #if DEVICE_PORTIN || DEVICE_PORTOUT
ommpy 0:d383e2dee0f7 26
ommpy 0:d383e2dee0f7 27 #ifdef __cplusplus
ommpy 0:d383e2dee0f7 28 extern "C" {
ommpy 0:d383e2dee0f7 29 #endif
ommpy 0:d383e2dee0f7 30
ommpy 0:d383e2dee0f7 31 /** Port HAL structure. port_s is declared in the target's HAL
ommpy 0:d383e2dee0f7 32 */
ommpy 0:d383e2dee0f7 33 typedef struct port_s port_t;
ommpy 0:d383e2dee0f7 34
ommpy 0:d383e2dee0f7 35 /**
ommpy 0:d383e2dee0f7 36 * \defgroup hal_port Port HAL functions
ommpy 0:d383e2dee0f7 37 * @{
ommpy 0:d383e2dee0f7 38 */
ommpy 0:d383e2dee0f7 39
ommpy 0:d383e2dee0f7 40 /** Get the pin name from the port's pin number
ommpy 0:d383e2dee0f7 41 *
ommpy 0:d383e2dee0f7 42 * @param port The port name
ommpy 0:d383e2dee0f7 43 * @param pin_n The pin number within the specified port
ommpy 0:d383e2dee0f7 44 * @return The pin name for the port's pin number
ommpy 0:d383e2dee0f7 45 */
ommpy 0:d383e2dee0f7 46 PinName port_pin(PortName port, int pin_n);
ommpy 0:d383e2dee0f7 47
ommpy 0:d383e2dee0f7 48 /** Initilize the port
ommpy 0:d383e2dee0f7 49 *
ommpy 0:d383e2dee0f7 50 * @param obj The port object to initialize
ommpy 0:d383e2dee0f7 51 * @param port The port name
ommpy 0:d383e2dee0f7 52 * @param mask The bitmask to identify which bits in the port should be included (0 - ignore)
ommpy 0:d383e2dee0f7 53 * @param dir The port direction
ommpy 0:d383e2dee0f7 54 */
ommpy 0:d383e2dee0f7 55 void port_init(port_t *obj, PortName port, int mask, PinDirection dir);
ommpy 0:d383e2dee0f7 56
ommpy 0:d383e2dee0f7 57 /** Set the input port mode
ommpy 0:d383e2dee0f7 58 *
ommpy 0:d383e2dee0f7 59 * @param obj The port object
ommpy 0:d383e2dee0f7 60 * @param mode THe port mode to be set
ommpy 0:d383e2dee0f7 61 */
ommpy 0:d383e2dee0f7 62 void port_mode(port_t *obj, PinMode mode);
ommpy 0:d383e2dee0f7 63
ommpy 0:d383e2dee0f7 64 /** Set port direction (in/out)
ommpy 0:d383e2dee0f7 65 *
ommpy 0:d383e2dee0f7 66 * @param obj The port object
ommpy 0:d383e2dee0f7 67 * @param dir The port direction to be set
ommpy 0:d383e2dee0f7 68 */
ommpy 0:d383e2dee0f7 69 void port_dir(port_t *obj, PinDirection dir);
ommpy 0:d383e2dee0f7 70
ommpy 0:d383e2dee0f7 71 /** Write value to the port
ommpy 0:d383e2dee0f7 72 *
ommpy 0:d383e2dee0f7 73 * @param obj The port object
ommpy 0:d383e2dee0f7 74 * @param value The value to be set
ommpy 0:d383e2dee0f7 75 */
ommpy 0:d383e2dee0f7 76 void port_write(port_t *obj, int value);
ommpy 0:d383e2dee0f7 77
ommpy 0:d383e2dee0f7 78 /** Read the current value on the port
ommpy 0:d383e2dee0f7 79 *
ommpy 0:d383e2dee0f7 80 * @param obj The port object
ommpy 0:d383e2dee0f7 81 * @return An integer with each bit corresponding to an associated port pin setting
ommpy 0:d383e2dee0f7 82 */
ommpy 0:d383e2dee0f7 83 int port_read(port_t *obj);
ommpy 0:d383e2dee0f7 84
ommpy 0:d383e2dee0f7 85 /**@}*/
ommpy 0:d383e2dee0f7 86
ommpy 0:d383e2dee0f7 87 #ifdef __cplusplus
ommpy 0:d383e2dee0f7 88 }
ommpy 0:d383e2dee0f7 89 #endif
ommpy 0:d383e2dee0f7 90 #endif
ommpy 0:d383e2dee0f7 91
ommpy 0:d383e2dee0f7 92 #endif
ommpy 0:d383e2dee0f7 93
ommpy 0:d383e2dee0f7 94 /** @}*/