include/linux/omap-gpmc.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  *  OMAP GPMC (General Purpose Memory Controller) defines
   4  */
   5
   6 #include <linux/platform_data/gpmc-omap.h>
   7
   8 #define GPMC_CONFIG_WP          0x00000005
   9
  10 /* IRQ numbers in GPMC IRQ domain for legacy boot use */
  11 #define GPMC_IRQ_FIFOEVENTENABLE        0
  12 #define GPMC_IRQ_COUNT_EVENT            1
  13
  14 /**
  15  * gpmc_nand_ops - Interface between NAND and GPMC
  16  * @nand_write_buffer_empty: get the NAND write buffer empty status.
  17  */
  18 struct gpmc_nand_ops {
  19         bool (*nand_writebuffer_empty)(void);
  20 };
  21
  22 struct gpmc_nand_regs;
  23
  24 struct gpmc_onenand_info {
  25         bool sync_read;
  26         bool sync_write;
  27         int burst_len;
  28 };
  29
  30 #if IS_ENABLED(CONFIG_OMAP_GPMC)
  31 struct gpmc_nand_ops *gpmc_omap_get_nand_ops(struct gpmc_nand_regs *regs,
  32                                              int cs);
  33 /**
  34  * gpmc_omap_onenand_set_timings - set optimized sync timings.
  35  * @cs:      Chip Select Region
  36  * @freq:    Chip frequency
  37  * @latency: Burst latency cycle count
  38  * @info:    Structure describing parameters used
  39  *
  40  * Sets optimized timings for the @cs region based on @freq and @latency.
  41  * Updates the @info structure based on the GPMC settings.
  42  */
  43 int gpmc_omap_onenand_set_timings(struct device *dev, int cs, int freq,
  44                                   int latency,
  45                                   struct gpmc_onenand_info *info);
  46
  47 #else
  48 static inline struct gpmc_nand_ops *gpmc_omap_get_nand_ops(struct gpmc_nand_regs *regs,
  49                                                            int cs)
  50 {
  51         return NULL;
  52 }
  53
  54 static inline
  55 int gpmc_omap_onenand_set_timings(struct device *dev, int cs, int freq,
  56                                   int latency,
  57                                   struct gpmc_onenand_info *info)
  58 {
  59         return -EINVAL;
  60 }
  61 #endif /* CONFIG_OMAP_GPMC */
  62
  63 extern int gpmc_calc_timings(struct gpmc_timings *gpmc_t,
  64                              struct gpmc_settings *gpmc_s,
  65                              struct gpmc_device_timings *dev_t);
  66
  67 struct device_node;
  68
  69 extern int gpmc_get_client_irq(unsigned irq_config);
  70
  71 extern unsigned int gpmc_ticks_to_ns(unsigned int ticks);
  72
  73 extern void gpmc_cs_write_reg(int cs, int idx, u32 val);
  74 extern int gpmc_calc_divider(unsigned int sync_clk);
  75 extern int gpmc_cs_set_timings(int cs, const struct gpmc_timings *t,
  76                                const struct gpmc_settings *s);
  77 extern int gpmc_cs_program_settings(int cs, struct gpmc_settings *p);
  78 extern int gpmc_cs_request(int cs, unsigned long size, unsigned long *base);
  79 extern void gpmc_cs_free(int cs);
  80 extern int gpmc_configure(int cmd, int wval);
  81 extern void gpmc_read_settings_dt(struct device_node *np,
  82                                   struct gpmc_settings *p);
  83
  84 extern void omap3_gpmc_save_context(void);
  85 extern void omap3_gpmc_restore_context(void);
  86
  87 struct gpmc_timings;
  88 struct omap_nand_platform_data;
  89 struct omap_onenand_platform_data;
  90
  91 #if IS_ENABLED(CONFIG_MTD_ONENAND_OMAP2)
  92 extern int gpmc_onenand_init(struct omap_onenand_platform_data *d);
  93 #else
  94 #define board_onenand_data      NULL
  95 static inline int gpmc_onenand_init(struct omap_onenand_platform_data *d)
  96 {
  97         return 0;
  98 }
  99 #endif