Aditya Mehrotra / mbed-dev

Biomimetics MBED Library w/ Added Support for CAN3

Dependents:   CAN_TEST SPIne_Plus_DYNO_SENSORS SPIne_Plus_v2 SPIne_Plus_Dyno_v2

hal/port_api.h@3:993b4d6ff61e, 2021-03-09 (annotated)

Committer:
adimmit
Date:
Tue Mar 09 20:33:24 2021 +0000
Revision:
3:993b4d6ff61e
Parent:
0:083111ae2a11 
added CAN3

Who changed what in which revision?

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