2014-05-03 16:27:38 -06:00
|
|
|
/*
|
|
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
|
|
|
*
|
|
|
|
* The MIT License (MIT)
|
|
|
|
*
|
|
|
|
* Copyright (c) 2013, 2014 Damien P. George
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2014-06-15 23:33:14 -06:00
|
|
|
// This file requires pin_defs_xxx.h (which has port specific enums and
|
|
|
|
// defines, so we include it here. It should never be included directly
|
2014-03-12 19:06:26 -06:00
|
|
|
|
2014-07-02 06:42:37 -06:00
|
|
|
#include MICROPY_PIN_DEFS_PORT_H
|
2014-03-24 11:49:23 -06:00
|
|
|
|
2014-03-12 19:06:26 -06:00
|
|
|
typedef struct {
|
|
|
|
mp_obj_base_t base;
|
2014-07-22 08:57:36 -06:00
|
|
|
qstr name;
|
2014-03-12 19:06:26 -06:00
|
|
|
uint8_t idx;
|
|
|
|
uint8_t fn;
|
|
|
|
uint8_t unit;
|
|
|
|
uint8_t type;
|
|
|
|
|
|
|
|
union {
|
|
|
|
void *reg;
|
2014-06-15 23:33:14 -06:00
|
|
|
|
|
|
|
PIN_DEFS_PORT_AF_UNION
|
2014-03-12 19:06:26 -06:00
|
|
|
};
|
|
|
|
} pin_af_obj_t;
|
|
|
|
|
|
|
|
typedef struct {
|
|
|
|
mp_obj_base_t base;
|
2014-07-22 08:57:36 -06:00
|
|
|
qstr name;
|
2014-06-15 23:33:14 -06:00
|
|
|
uint32_t port : 4;
|
|
|
|
uint32_t pin : 5; // Some ARM processors use 32 bits/PORT
|
|
|
|
uint32_t num_af : 4;
|
|
|
|
uint32_t adc_channel : 5; // Some ARM processors use 32 bits/PORT
|
|
|
|
uint32_t adc_num : 3; // 1 bit per ADC
|
|
|
|
uint32_t pin_mask;
|
|
|
|
pin_gpio_t *gpio;
|
2014-03-12 19:06:26 -06:00
|
|
|
const pin_af_obj_t *af;
|
|
|
|
} pin_obj_t;
|
|
|
|
|
2014-04-18 15:38:09 -06:00
|
|
|
extern const mp_obj_type_t pin_type;
|
|
|
|
extern const mp_obj_type_t pin_af_type;
|
2014-03-12 19:06:26 -06:00
|
|
|
|
|
|
|
typedef struct {
|
2014-04-18 15:38:09 -06:00
|
|
|
const char *name;
|
2014-03-12 19:06:26 -06:00
|
|
|
const pin_obj_t *pin;
|
|
|
|
} pin_named_pin_t;
|
|
|
|
|
|
|
|
extern const pin_named_pin_t pin_board_pins[];
|
|
|
|
extern const pin_named_pin_t pin_cpu_pins[];
|
|
|
|
|
2014-04-18 15:38:09 -06:00
|
|
|
//extern pin_map_obj_t pin_map_obj;
|
2014-03-12 19:06:26 -06:00
|
|
|
|
|
|
|
typedef struct {
|
|
|
|
mp_obj_base_t base;
|
2014-04-18 15:38:09 -06:00
|
|
|
qstr name;
|
2014-03-12 19:06:26 -06:00
|
|
|
const pin_named_pin_t *named_pins;
|
|
|
|
} pin_named_pins_obj_t;
|
|
|
|
|
2014-07-22 08:57:36 -06:00
|
|
|
extern const mp_obj_type_t pin_board_pins_obj_type;
|
|
|
|
extern const mp_obj_type_t pin_cpu_pins_obj_type;
|
|
|
|
|
|
|
|
extern const mp_obj_dict_t pin_cpu_pins_locals_dict;
|
|
|
|
extern const mp_obj_dict_t pin_board_pins_locals_dict;
|
2014-03-12 19:06:26 -06:00
|
|
|
|
2014-08-20 14:21:11 -06:00
|
|
|
MP_DECLARE_CONST_FUN_OBJ(pin_init_obj);
|
|
|
|
|
2014-08-04 04:09:51 -06:00
|
|
|
void pin_init0(void);
|
2014-07-22 08:57:36 -06:00
|
|
|
uint32_t pin_get_mode(const pin_obj_t *pin);
|
|
|
|
uint32_t pin_get_pull(const pin_obj_t *pin);
|
|
|
|
uint32_t pin_get_af(const pin_obj_t *pin);
|
2014-04-18 15:38:09 -06:00
|
|
|
const pin_obj_t *pin_find(mp_obj_t user_obj);
|
2014-07-22 08:57:36 -06:00
|
|
|
const pin_obj_t *pin_find_named_pin(const mp_obj_dict_t *named_pins, mp_obj_t name);
|
2014-08-20 14:21:11 -06:00
|
|
|
const pin_af_obj_t *pin_find_af(const pin_obj_t *pin, uint8_t fn, uint8_t unit);
|
2014-07-22 08:57:36 -06:00
|
|
|
const pin_af_obj_t *pin_find_af_by_index(const pin_obj_t *pin, mp_uint_t af_idx);
|
|
|
|
const pin_af_obj_t *pin_find_af_by_name(const pin_obj_t *pin, const char *name);
|