arch/arm/mach-omap2/mux.h

   1 /*
   2  * Copyright (C) 2009 Nokia
   3  * Copyright (C) 2009-2010 Texas Instruments
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  */
   9
  10 #include "mux2420.h"
  11 #include "mux2430.h"
  12 #include "mux34xx.h"
  13 #include "mux44xx.h"
  14
  15 #define OMAP_MUX_TERMINATOR     0xffff
  16
  17 /* 34xx mux mode options for each pin. See TRM for options */
  18 #define OMAP_MUX_MODE0      0
  19 #define OMAP_MUX_MODE1      1
  20 #define OMAP_MUX_MODE2      2
  21 #define OMAP_MUX_MODE3      3
  22 #define OMAP_MUX_MODE4      4
  23 #define OMAP_MUX_MODE5      5
  24 #define OMAP_MUX_MODE6      6
  25 #define OMAP_MUX_MODE7      7
  26
  27 /* 24xx/34xx mux bit defines */
  28 #define OMAP_PULL_ENA                   (1 << 3)
  29 #define OMAP_PULL_UP                    (1 << 4)
  30 #define OMAP_ALTELECTRICALSEL           (1 << 5)
  31
  32 /* 34xx specific mux bit defines */
  33 #define OMAP_INPUT_EN                   (1 << 8)
  34 #define OMAP_OFF_EN                     (1 << 9)
  35 #define OMAP_OFFOUT_EN                  (1 << 10)
  36 #define OMAP_OFFOUT_VAL                 (1 << 11)
  37 #define OMAP_OFF_PULL_EN                (1 << 12)
  38 #define OMAP_OFF_PULL_UP                (1 << 13)
  39 #define OMAP_WAKEUP_EN                  (1 << 14)
  40
  41 /* 44xx specific mux bit defines */
  42 #define OMAP_WAKEUP_EVENT               (1 << 15)
  43
  44 /* Active pin states */
  45 #define OMAP_PIN_OUTPUT                 0
  46 #define OMAP_PIN_INPUT                  OMAP_INPUT_EN
  47 #define OMAP_PIN_INPUT_PULLUP           (OMAP_PULL_ENA | OMAP_INPUT_EN \
  48                                                 | OMAP_PULL_UP)
  49 #define OMAP_PIN_INPUT_PULLDOWN         (OMAP_PULL_ENA | OMAP_INPUT_EN)
  50
  51 /* Off mode states */
  52 #define OMAP_PIN_OFF_NONE               0
  53 #define OMAP_PIN_OFF_OUTPUT_HIGH        (OMAP_OFF_EN | OMAP_OFFOUT_EN \
  54                                                 | OMAP_OFFOUT_VAL)
  55 #define OMAP_PIN_OFF_OUTPUT_LOW         (OMAP_OFF_EN | OMAP_OFFOUT_EN)
  56 #define OMAP_PIN_OFF_INPUT_PULLUP       (OMAP_OFF_EN | OMAP_OFF_PULL_EN \
  57                                                 | OMAP_OFF_PULL_UP)
  58 #define OMAP_PIN_OFF_INPUT_PULLDOWN     (OMAP_OFF_EN | OMAP_OFF_PULL_EN)
  59 #define OMAP_PIN_OFF_WAKEUPENABLE       OMAP_WAKEUP_EN
  60
  61 #define OMAP_MODE_GPIO(x)       (((x) & OMAP_MUX_MODE7) == OMAP_MUX_MODE4)
  62
  63 /* Flags for omapX_mux_init */
  64 #define OMAP_PACKAGE_MASK               0xffff
  65 #define OMAP_PACKAGE_CBS                8               /* 547-pin 0.40 0.40 */
  66 #define OMAP_PACKAGE_CBL                7               /* 547-pin 0.40 0.40 */
  67 #define OMAP_PACKAGE_CBP                6               /* 515-pin 0.40 0.50 */
  68 #define OMAP_PACKAGE_CUS                5               /* 423-pin 0.65 */
  69 #define OMAP_PACKAGE_CBB                4               /* 515-pin 0.40 0.50 */
  70 #define OMAP_PACKAGE_CBC                3               /* 515-pin 0.50 0.65 */
  71 #define OMAP_PACKAGE_ZAC                2               /* 24xx 447-pin POP */
  72 #define OMAP_PACKAGE_ZAF                1               /* 2420 447-pin SIP */
  73
  74
  75 #define OMAP_MUX_NR_MODES               8               /* Available modes */
  76 #define OMAP_MUX_NR_SIDES               2               /* Bottom & top */
  77
  78 /*
  79  * omap_mux_init flags definition:
  80  *
  81  * OMAP_MUX_REG_8BIT: Ensure that access to padconf is done in 8 bits.
  82  * The default value is 16 bits.
  83  * OMAP_MUX_GPIO_IN_MODE3: The GPIO is selected in mode3.
  84  * The default is mode4.
  85  */
  86 #define OMAP_MUX_REG_8BIT               (1 << 0)
  87 #define OMAP_MUX_GPIO_IN_MODE3          (1 << 1)
  88
  89 /**
  90  * struct omap_board_data - board specific device data
  91  * @id: instance id
  92  * @flags: additional flags for platform init code
  93  * @pads: array of device specific pads
  94  * @pads_cnt: ARRAY_SIZE() of pads
  95  */
  96 struct omap_board_data {
  97         int                     id;
  98         u32                     flags;
  99         struct omap_device_pad  *pads;
 100         int                     pads_cnt;
 101 };
 102
 103 /**
 104  * struct mux_partition - contain partition related information
 105  * @name: name of the current partition
 106  * @flags: flags specific to this partition
 107  * @phys: physical address
 108  * @size: partition size
 109  * @base: virtual address after ioremap
 110  * @muxmodes: list of nodes that belong to a partition
 111  * @node: list node for the partitions linked list
 112  */
 113 struct omap_mux_partition {
 114         const char              *name;
 115         u32                     flags;
 116         u32                     phys;
 117         u32                     size;
 118         void __iomem            *base;
 119         struct list_head        muxmodes;
 120         struct list_head        node;
 121 };
 122
 123 /**
 124  * struct omap_mux - data for omap mux register offset and it's value
 125  * @reg_offset: mux register offset from the mux base
 126  * @gpio:       GPIO number
 127  * @muxnames:   available signal modes for a ball
 128  * @balls:      available balls on the package
 129  * @partition:  mux partition
 130  */
 131 struct omap_mux {
 132         u16     reg_offset;
 133         u16     gpio;
 134 #ifdef CONFIG_OMAP_MUX
 135         char    *muxnames[OMAP_MUX_NR_MODES];
 136 #ifdef CONFIG_DEBUG_FS
 137         char    *balls[OMAP_MUX_NR_SIDES];
 138 #endif
 139 #endif
 140 };
 141
 142 /**
 143  * struct omap_ball - data for balls on omap package
 144  * @reg_offset: mux register offset from the mux base
 145  * @balls:      available balls on the package
 146  */
 147 struct omap_ball {
 148         u16     reg_offset;
 149         char    *balls[OMAP_MUX_NR_SIDES];
 150 };
 151
 152 /**
 153  * struct omap_board_mux - data for initializing mux registers
 154  * @reg_offset: mux register offset from the mux base
 155  * @mux_value:  desired mux value to set
 156  */
 157 struct omap_board_mux {
 158         u16     reg_offset;
 159         u16     value;
 160 };
 161
 162 #define OMAP_DEVICE_PAD_ENABLED         BIT(7)  /* Not needed for board-*.c */
 163 #define OMAP_DEVICE_PAD_REMUX           BIT(1)  /* Dynamically remux a pad,
 164                                                    needs enable, idle and off
 165                                                    values */
 166 #define OMAP_DEVICE_PAD_WAKEUP          BIT(0)  /* Pad is wake-up capable */
 167
 168 /**
 169  * struct omap_device_pad - device specific pad configuration
 170  * @name:               signal name
 171  * @flags:              pad specific runtime flags
 172  * @enable:             runtime value for a pad
 173  * @idle:               idle value for a pad
 174  * @off:                off value for a pad, defaults to safe mode
 175  * @partition:          mux partition
 176  * @mux:                mux register
 177  */
 178 struct omap_device_pad {
 179         char                            *name;
 180         u8                              flags;
 181         u16                             enable;
 182         u16                             idle;
 183         u16                             off;
 184         struct omap_mux_partition       *partition;
 185         struct omap_mux                 *mux;
 186 };
 187
 188 struct omap_hwmod_mux_info;
 189
 190 #if defined(CONFIG_OMAP_MUX)
 191
 192 /**
 193  * omap_mux_init_gpio - initialize a signal based on the GPIO number
 194  * @gpio:               GPIO number
 195  * @val:                Options for the mux register value
 196  */
 197 int omap_mux_init_gpio(int gpio, int val);
 198
 199 /**
 200  * omap_mux_init_signal - initialize a signal based on the signal name
 201  * @muxname:            Mux name in mode0_name.signal_name format
 202  * @val:                Options for the mux register value
 203  */
 204 int omap_mux_init_signal(const char *muxname, int val);
 205
 206 /**
 207  * omap_hwmod_mux_init - initialize hwmod specific mux data
 208  * @bpads:              Board specific device signal names
 209  * @nr_pads:            Number of signal names for the device
 210  */
 211 extern struct omap_hwmod_mux_info *
 212 omap_hwmod_mux_init(struct omap_device_pad *bpads, int nr_pads);
 213
 214 /**
 215  * omap_hwmod_mux - omap hwmod specific pin muxing
 216  * @hmux:               Pads for a hwmod
 217  * @state:              Desired _HWMOD_STATE
 218  *
 219  * Called only from omap_hwmod.c, do not use.
 220  */
 221 void omap_hwmod_mux(struct omap_hwmod_mux_info *hmux, u8 state);
 222
 223 #else
 224
 225 static inline int omap_mux_init_gpio(int gpio, int val)
 226 {
 227         return 0;
 228 }
 229 static inline int omap_mux_init_signal(char *muxname, int val)
 230 {
 231         return 0;
 232 }
 233
 234 static inline struct omap_hwmod_mux_info *
 235 omap_hwmod_mux_init(struct omap_device_pad *bpads, int nr_pads)
 236 {
 237         return NULL;
 238 }
 239
 240 static inline void omap_hwmod_mux(struct omap_hwmod_mux_info *hmux, u8 state)
 241 {
 242 }
 243
 244 static struct omap_board_mux *board_mux __initdata __maybe_unused;
 245
 246 #endif
 247
 248 /**
 249  * omap_mux_get_gpio() - get mux register value based on GPIO number
 250  * @gpio:               GPIO number
 251  *
 252  */
 253 u16 omap_mux_get_gpio(int gpio);
 254
 255 /**
 256  * omap_mux_set_gpio() - set mux register value based on GPIO number
 257  * @val:                New mux register value
 258  * @gpio:               GPIO number
 259  *
 260  */
 261 void omap_mux_set_gpio(u16 val, int gpio);
 262
 263 /**
 264  * omap_mux_get() - get a mux partition by name
 265  * @name:               Name of the mux partition
 266  *
 267  */
 268 struct omap_mux_partition *omap_mux_get(const char *name);
 269
 270 /**
 271  * omap_mux_read() - read mux register
 272  * @partition:          Mux partition
 273  * @mux_offset:         Offset of the mux register
 274  *
 275  */
 276 u16 omap_mux_read(struct omap_mux_partition *p, u16 mux_offset);
 277
 278 /**
 279  * omap_mux_write() - write mux register
 280  * @partition:          Mux partition
 281  * @val:                New mux register value
 282  * @mux_offset:         Offset of the mux register
 283  *
 284  * This should be only needed for dynamic remuxing of non-gpio signals.
 285  */
 286 void omap_mux_write(struct omap_mux_partition *p, u16 val, u16 mux_offset);
 287
 288 /**
 289  * omap_mux_write_array() - write an array of mux registers
 290  * @partition:          Mux partition
 291  * @board_mux:          Array of mux registers terminated by MAP_MUX_TERMINATOR
 292  *
 293  * This should be only needed for dynamic remuxing of non-gpio signals.
 294  */
 295 void omap_mux_write_array(struct omap_mux_partition *p,
 296                           struct omap_board_mux *board_mux);
 297
 298 /**
 299  * omap2420_mux_init() - initialize mux system with board specific set
 300  * @board_mux:          Board specific mux table
 301  * @flags:              OMAP package type used for the board
 302  */
 303 int omap2420_mux_init(struct omap_board_mux *board_mux, int flags);
 304
 305 /**
 306  * omap2430_mux_init() - initialize mux system with board specific set
 307  * @board_mux:          Board specific mux table
 308  * @flags:              OMAP package type used for the board
 309  */
 310 int omap2430_mux_init(struct omap_board_mux *board_mux, int flags);
 311
 312 /**
 313  * omap3_mux_init() - initialize mux system with board specific set
 314  * @board_mux:          Board specific mux table
 315  * @flags:              OMAP package type used for the board
 316  */
 317 int omap3_mux_init(struct omap_board_mux *board_mux, int flags);
 318
 319 /**
 320  * omap4_mux_init() - initialize mux system with board specific set
 321  * @board_mux:          Board specific mux table
 322  * @flags:              OMAP package type used for the board
 323  */
 324 int omap4_mux_init(struct omap_board_mux *board_mux, int flags);
 325
 326 /**
 327  * omap_mux_init - private mux init function, do not call
 328  */
 329 int omap_mux_init(const char *name, u32 flags,
 330                   u32 mux_pbase, u32 mux_size,
 331                   struct omap_mux *superset,
 332                   struct omap_mux *package_subset,
 333                   struct omap_board_mux *board_mux,
 334                   struct omap_ball *package_balls);
 335