drivers/pinctrl/pinctrl-msm.h

   1 /*
   2  * Copyright (c) 2013, Sony Mobile Communications AB.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 and
   6  * only version 2 as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  */
  13 #ifndef __PINCTRL_MSM_H__
  14 #define __PINCTRL_MSM_H__
  15
  16 struct pinctrl_pin_desc;
  17
  18 /**
  19  * struct msm_function - a pinmux function
  20  * @name:    Name of the pinmux function.
  21  * @groups:  List of pingroups for this function.
  22  * @ngroups: Number of entries in @groups.
  23  */
  24 struct msm_function {
  25         const char *name;
  26         const char * const *groups;
  27         unsigned ngroups;
  28 };
  29
  30 /**
  31  * struct msm_pingroup - Qualcomm pingroup definition
  32  * @name:                 Name of the pingroup.
  33  * @pins:                 A list of pins assigned to this pingroup.
  34  * @npins:                Number of entries in @pins.
  35  * @funcs:                A list of pinmux functions that can be selected for
  36  *                        this group. The index of the selected function is used
  37  *                        for programming the function selector.
  38  *                        Entries should be indices into the groups list of the
  39  *                        struct msm_pinctrl_soc_data.
  40  * @ctl_reg:              Offset of the register holding control bits for this group.
  41  * @io_reg:               Offset of the register holding input/output bits for this group.
  42  * @intr_cfg_reg:         Offset of the register holding interrupt configuration bits.
  43  * @intr_status_reg:      Offset of the register holding the status bits for this group.
  44  * @intr_target_reg:      Offset of the register specifying routing of the interrupts
  45  *                        from this group.
  46  * @mux_bit:              Offset in @ctl_reg for the pinmux function selection.
  47  * @pull_bit:             Offset in @ctl_reg for the bias configuration.
  48  * @drv_bit:              Offset in @ctl_reg for the drive strength configuration.
  49  * @oe_bit:               Offset in @ctl_reg for controlling output enable.
  50  * @in_bit:               Offset in @io_reg for the input bit value.
  51  * @out_bit:              Offset in @io_reg for the output bit value.
  52  * @intr_enable_bit:      Offset in @intr_cfg_reg for enabling the interrupt for this group.
  53  * @intr_status_bit:      Offset in @intr_status_reg for reading and acking the interrupt
  54  *                        status.
  55  * @intr_target_bit:      Offset in @intr_target_reg for configuring the interrupt routing.
  56  * @intr_raw_status_bit:  Offset in @intr_cfg_reg for the raw status bit.
  57  * @intr_polarity_bit:    Offset in @intr_cfg_reg for specifying polarity of the interrupt.
  58  * @intr_detection_bit:   Offset in @intr_cfg_reg for specifying interrupt type.
  59  * @intr_detection_width: Number of bits used for specifying interrupt type,
  60  *                        Should be 2 for SoCs that can detect both edges in hardware,
  61  *                        otherwise 1.
  62  */
  63 struct msm_pingroup {
  64         const char *name;
  65         const unsigned *pins;
  66         unsigned npins;
  67
  68         unsigned *funcs;
  69         unsigned nfuncs;
  70
  71         s16 ctl_reg;
  72         s16 io_reg;
  73         s16 intr_cfg_reg;
  74         s16 intr_status_reg;
  75         s16 intr_target_reg;
  76
  77         unsigned mux_bit:5;
  78
  79         unsigned pull_bit:5;
  80         unsigned drv_bit:5;
  81
  82         unsigned oe_bit:5;
  83         unsigned in_bit:5;
  84         unsigned out_bit:5;
  85
  86         unsigned intr_enable_bit:5;
  87         unsigned intr_status_bit:5;
  88         unsigned intr_ack_high:1;
  89
  90         unsigned intr_target_bit:5;
  91         unsigned intr_raw_status_bit:5;
  92         unsigned intr_polarity_bit:5;
  93         unsigned intr_detection_bit:5;
  94         unsigned intr_detection_width:5;
  95 };
  96
  97 /**
  98  * struct msm_pinctrl_soc_data - Qualcomm pin controller driver configuration
  99  * @pins:       An array describing all pins the pin controller affects.
 100  * @npins:      The number of entries in @pins.
 101  * @functions:  An array describing all mux functions the SoC supports.
 102  * @nfunctions: The number of entries in @functions.
 103  * @groups:     An array describing all pin groups the pin SoC supports.
 104  * @ngroups:    The numbmer of entries in @groups.
 105  * @ngpio:      The number of pingroups the driver should expose as GPIOs.
 106  */
 107 struct msm_pinctrl_soc_data {
 108         const struct pinctrl_pin_desc *pins;
 109         unsigned npins;
 110         const struct msm_function *functions;
 111         unsigned nfunctions;
 112         const struct msm_pingroup *groups;
 113         unsigned ngroups;
 114         unsigned ngpios;
 115 };
 116
 117 int msm_pinctrl_probe(struct platform_device *pdev,
 118                       const struct msm_pinctrl_soc_data *soc_data);
 119 int msm_pinctrl_remove(struct platform_device *pdev);
 120
 121 #endif