Commit e9fdcc2d authored by Andy Shevchenko's avatar Andy Shevchenko
Browse files

Documentation: gpio: Advertise irqd_to_hwirq() helper in the examples 



Instead of direct dereferencing the IRQ data in order to get HW IRQ number
use the irqd_to_hwirq() helper.

Fixes: 5644b66a ("Documentation: Update the recommended pattern for GPIO irqchips")
Signed-off-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: default avatarLinus Walleij <linus.walleij@linaro.org>
parent bdb6528e

Documentation/driver-api/gpio/driver.rst

+12 −6
Original line number Original line Diff line number Diff line
@@ -430,6 +430,7 @@ call into the core gpiolib code: 
  static void my_gpio_mask_irq(struct irq_data *d)

  static void my_gpio_mask_irq(struct irq_data *d)

  {

  {

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      irq_hw_number_t hwirq = irqd_to_hwirq(d);





      /*

      /*

       * Perform any necessary action to mask the interrupt,

       * Perform any necessary action to mask the interrupt,
@@ -437,14 +438,15 @@ call into the core gpiolib code: 
       * state.

       * state.

       */

       */





      gpiochip_disable_irq(gc, d->hwirq);

      gpiochip_disable_irq(gc, hwirq);

  }

  }





  static void my_gpio_unmask_irq(struct irq_data *d)

  static void my_gpio_unmask_irq(struct irq_data *d)

  {

  {

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      irq_hw_number_t hwirq = irqd_to_hwirq(d);





      gpiochip_enable_irq(gc, d->hwirq);

      gpiochip_enable_irq(gc, hwirq);





      /*

      /*

       * Perform any necessary action to unmask the interrupt,

       * Perform any necessary action to unmask the interrupt,
@@ -502,6 +504,7 @@ the interrupt separately and go with it: 
  static void my_gpio_mask_irq(struct irq_data *d)

  static void my_gpio_mask_irq(struct irq_data *d)

  {

  {

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      irq_hw_number_t hwirq = irqd_to_hwirq(d);





      /*

      /*

       * Perform any necessary action to mask the interrupt,

       * Perform any necessary action to mask the interrupt,
@@ -509,14 +512,15 @@ the interrupt separately and go with it: 
       * state.

       * state.

       */

       */





      gpiochip_disable_irq(gc, d->hwirq);

      gpiochip_disable_irq(gc, hwirq);

  }

  }





  static void my_gpio_unmask_irq(struct irq_data *d)

  static void my_gpio_unmask_irq(struct irq_data *d)

  {

  {

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      irq_hw_number_t hwirq = irqd_to_hwirq(d);





      gpiochip_enable_irq(gc, d->hwirq);

      gpiochip_enable_irq(gc, hwirq);





      /*

      /*

       * Perform any necessary action to unmask the interrupt,

       * Perform any necessary action to unmask the interrupt,
@@ -577,6 +581,7 @@ In this case the typical set-up will look like this: 
  static void my_gpio_mask_irq(struct irq_data *d)

  static void my_gpio_mask_irq(struct irq_data *d)

  {

  {

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      irq_hw_number_t hwirq = irqd_to_hwirq(d);





      /*

      /*

       * Perform any necessary action to mask the interrupt,

       * Perform any necessary action to mask the interrupt,
@@ -584,15 +589,16 @@ In this case the typical set-up will look like this: 
       * state.

       * state.

       */

       */





      gpiochip_disable_irq(gc, d->hwirq);

      gpiochip_disable_irq(gc, hwirq);

      irq_mask_mask_parent(d);

      irq_mask_mask_parent(d);

  }

  }





  static void my_gpio_unmask_irq(struct irq_data *d)

  static void my_gpio_unmask_irq(struct irq_data *d)

  {

  {

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      struct gpio_chip *gc = irq_data_get_irq_chip_data(d);

      irq_hw_number_t hwirq = irqd_to_hwirq(d);





      gpiochip_enable_irq(gc, d->hwirq);

      gpiochip_enable_irq(gc, hwirq);





      /*

      /*

       * Perform any necessary action to unmask the interrupt,

       * Perform any necessary action to unmask the interrupt,