circuitpython/ports/stm32f4/common-hal/microcontroller/Pin.h

54 lines
2.1 KiB
C
Raw Normal View History

2019-06-28 15:36:08 -04:00
/*
* This file is part of the MicroPython project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2016 Scott Shawcroft
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
2019-07-17 14:07:33 -04:00
#ifndef MICROPY_INCLUDED_STM34F4_COMMON_HAL_MICROCONTROLLER_PIN_H
#define MICROPY_INCLUDED_STM34F4_COMMON_HAL_MICROCONTROLLER_PIN_H
2019-06-28 15:36:08 -04:00
#include "py/mphal.h"
2019-07-17 14:07:33 -04:00
#include "peripherals/stm32f4/pins.h"
2019-06-28 15:36:08 -04:00
void reset_all_pins(void);
// reset_pin_number takes the pin number instead of the pointer so that objects don't
// need to store a full pointer.
void reset_pin_number(uint8_t pin);
2019-06-28 15:36:08 -04:00
void claim_pin(const mcu_pin_obj_t* pin);
bool pin_number_is_free(uint8_t pin);
void never_reset_pin_number(uint8_t pin);
void* pin_port(uint8_t pin);
uint16_t pin_mask(uint8_t pin);
//helper functions for unpacking the pin object "number" into hal-usable addr/mask
static inline uint8_t gpio_port_num(uint8_t packed_pin) {
return packed_pin >> 4;
}
static inline uint16_t gpio_mask(uint8_t packed_pin) {
return 1 << (0x0F & packed_pin);
}
2019-06-28 15:36:08 -04:00
2019-07-17 14:07:33 -04:00
#endif // MICROPY_INCLUDED_STM34F4_COMMON_HAL_MICROCONTROLLER_PIN_H