Blame view

RIOT/drivers/include/gpioint.h 2.06 KB
fb11e647   vrobic   reseau statique a...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
  /*
   * Copyright 2009, Freie Universitaet Berlin (FUB). All rights reserved.
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @defgroup    drivers_gpioint GPIO IRQ Multiplexer
   * @ingroup     drivers
   * @brief       Provides an API to implement interrupt handlers on IO pins.
   *
   * Multiplexer and interrupt handling must be implemented platform specific.
   *
   * @{
   *
   * @file
   * @brief       GPIO IRQ Multiplexer interface
   *
   * @author      Michael Baar <michael.baar@fu-berlin.de>
   */
  
  #ifndef GPIOINT_H_
  #define GPIOINT_H_
  
  #include <stdint.h>
  #include <stdbool.h>
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /*
   * @brief   GPIO IRQ multiplexer flags
   *
   * @note    We rely on the exact values for the edges.
   * @note    These flags are extended in hal/drivers/device-gpio.h
   *
   * @{
   */
  #define GPIOINT_DISABLE         0x00    /**< disable interrupt */
  #define GPIOINT_RISING_EDGE     0x01    /**< interrupt is generated on rising edge */
  #define GPIOINT_FALLING_EDGE    0x02    /**< interrupt is generated on falling edge */
  #define GPIOINT_DEBOUNCE        0x04    /**< debounce this interrupt */
  /** @} */
  
  /**
   * @brief   GPIO IRQ callback function type
   */
  typedef void(*fp_irqcb)(void);
  
  /**
   * @brief   GPIO IRQ handler setup
   * @param[in]   port        CPU specific port number (starting at 0)
   * @param[in]   bitmask     One or more bits for which to set the handler
   * @param[in]   flags       A combination of #GPIOINT_RISING_EDGE and #GPIOINT_FALLING_EDGE
   * @param[in]   callback    A pointer to a handler function
   * @retval      true        successful
   * @retval      false       failed
   *
   * To enable interrupt handling for a pin flags and callback must be non-zero. To disable interrupt
   * handling flags and callback shall be zero.
   */
  bool gpioint_set(int port, uint32_t bitmask, int flags, fp_irqcb callback);
  
  /**
   * @brief   Initialize the multiplexer
   */
  void gpioint_init(void);
  
  #ifdef __cplusplus
  }
  #endif
  
  /** @} */
  #endif /* GPIOINT_H_ */