123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120 |
- /*
- * ESPRESSIF MIT License
- *
- * Copyright (c) 2016 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
- *
- * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,
- * it is 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.
- *
- */
- #ifndef _GPIO_H_
- #define _GPIO_H_
- #define GPIO_PIN_ADDR(i) (GPIO_PIN0_ADDRESS + i*4)
- #define GPIO_ID_IS_PIN_REGISTER(reg_id) \
- ((reg_id >= GPIO_ID_PIN0) && (reg_id <= GPIO_ID_PIN(GPIO_PIN_COUNT-1)))
- #define GPIO_REGID_TO_PINIDX(reg_id) ((reg_id) - GPIO_ID_PIN0)
- typedef enum {
- GPIO_PIN_INTR_DISABLE = 0,
- GPIO_PIN_INTR_POSEDGE = 1,
- GPIO_PIN_INTR_NEGEDGE = 2,
- GPIO_PIN_INTR_ANYEDGE = 3,
- GPIO_PIN_INTR_LOLEVEL = 4,
- GPIO_PIN_INTR_HILEVEL = 5
- } GPIO_INT_TYPE;
- #define GPIO_OUTPUT_SET(gpio_no, bit_value) \
- gpio_output_set((bit_value)<<gpio_no, ((~(bit_value))&0x01)<<gpio_no, 1<<gpio_no,0)
- #define GPIO_DIS_OUTPUT(gpio_no) gpio_output_set(0,0,0, 1<<gpio_no)
- #define GPIO_INPUT_GET(gpio_no) ((gpio_input_get()>>gpio_no)&BIT0)
- /* GPIO interrupt handler, registered through gpio_intr_handler_register */
- typedef void (* gpio_intr_handler_fn_t)(uint32 intr_mask, void *arg);
- /*
- * Initialize GPIO. This includes reading the GPIO Configuration DataSet
- * to initialize "output enables" and pin configurations for each gpio pin.
- * Must be called once during startup.
- */
- void gpio_init(void);
- /*
- * Change GPIO pin output by setting, clearing, or disabling pins.
- * In general, it is expected that a bit will be set in at most one
- * of these masks. If a bit is clear in all masks, the output state
- * remains unchanged.
- *
- * There is no particular ordering guaranteed; so if the order of
- * writes is significant, calling code should divide a single call
- * into multiple calls.
- */
- void gpio_output_set(uint32 set_mask,
- uint32 clear_mask,
- uint32 enable_mask,
- uint32 disable_mask);
- /*
- * Sample the value of GPIO input pins and returns a bitmask.
- */
- uint32 gpio_input_get(void);
- /*
- * Set the specified GPIO register to the specified value.
- * This is a very general and powerful interface that is not
- * expected to be used during normal operation. It is intended
- * mainly for debug, or for unusual requirements.
- */
- void gpio_register_set(uint32 reg_id, uint32 value);
- /* Get the current value of the specified GPIO register. */
- uint32 gpio_register_get(uint32 reg_id);
- /*
- * Register an application-specific interrupt handler for GPIO pin
- * interrupts. Once the interrupt handler is called, it will not
- * be called again until after a call to gpio_intr_ack. Any GPIO
- * interrupts that occur during the interim are masked.
- *
- * The application-specific handler is called with a mask of
- * pending GPIO interrupts. After processing pin interrupts, the
- * application-specific handler may wish to use gpio_intr_pending
- * to check for any additional pending interrupts before it returns.
- */
- void gpio_intr_handler_register(gpio_intr_handler_fn_t fn, void *arg);
- /* Determine which GPIO interrupts are pending. */
- uint32 gpio_intr_pending(void);
- /*
- * Acknowledge GPIO interrupts.
- * Intended to be called from the gpio_intr_handler_fn.
- */
- void gpio_intr_ack(uint32 ack_mask);
- void gpio_pin_wakeup_enable(uint32 i, GPIO_INT_TYPE intr_state);
- void gpio_pin_wakeup_disable();
- void gpio_pin_intr_state_set(uint32 i, GPIO_INT_TYPE intr_state);
- #endif // _GPIO_H_
|