include/memory/renesas-rpc-if.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Renesas RPC-IF core driver
   4  *
   5  * Copyright (C) 2018~2019 Renesas Solutions Corp.
   6  * Copyright (C) 2019 Macronix International Co., Ltd.
   7  * Copyright (C) 2019-2020 Cogent Embedded, Inc.
   8  */
   9
  10 #ifndef __RENESAS_RPC_IF_H
  11 #define __RENESAS_RPC_IF_H
  12
  13 #include <linux/pm_runtime.h>
  14 #include <linux/types.h>
  15
  16 enum rpcif_data_dir {
  17         RPCIF_NO_DATA,
  18         RPCIF_DATA_IN,
  19         RPCIF_DATA_OUT,
  20 };
  21
  22 struct rpcif_op {
  23         struct {
  24                 u8 buswidth;
  25                 u8 opcode;
  26                 bool ddr;
  27         } cmd, ocmd;
  28
  29         struct {
  30                 u8 nbytes;
  31                 u8 buswidth;
  32                 bool ddr;
  33                 u64 val;
  34         } addr;
  35
  36         struct {
  37                 u8 ncycles;
  38                 u8 buswidth;
  39         } dummy;
  40
  41         struct {
  42                 u8 nbytes;
  43                 u8 buswidth;
  44                 bool ddr;
  45                 u32 val;
  46         } option;
  47
  48         struct {
  49                 u8 buswidth;
  50                 unsigned int nbytes;
  51                 enum rpcif_data_dir dir;
  52                 bool ddr;
  53                 union {
  54                         void *in;
  55                         const void *out;
  56                 } buf;
  57         } data;
  58 };
  59
  60 enum rpcif_type {
  61         RPCIF_RCAR_GEN3,
  62         RPCIF_RZ_G2L,
  63 };
  64
  65 struct rpcif {
  66         struct device *dev;
  67         void __iomem *base;
  68         void __iomem *dirmap;
  69         struct regmap *regmap;
  70         struct reset_control *rstc;
  71         size_t size;
  72         enum rpcif_type type;
  73         enum rpcif_data_dir dir;
  74         u8 bus_size;
  75         u8 xfer_size;
  76         void *buffer;
  77         u32 xferlen;
  78         u32 smcr;
  79         u32 smadr;
  80         u32 command;            /* DRCMR or SMCMR */
  81         u32 option;             /* DROPR or SMOPR */
  82         u32 enable;             /* DRENR or SMENR */
  83         u32 dummy;              /* DRDMCR or SMDMCR */
  84         u32 ddr;                /* DRDRENR or SMDRENR */
  85 };
  86
  87 int rpcif_sw_init(struct rpcif *rpc, struct device *dev);
  88 int rpcif_hw_init(struct rpcif *rpc, bool hyperflash);
  89 void rpcif_prepare(struct rpcif *rpc, const struct rpcif_op *op, u64 *offs,
  90                    size_t *len);
  91 int rpcif_manual_xfer(struct rpcif *rpc);
  92 ssize_t rpcif_dirmap_read(struct rpcif *rpc, u64 offs, size_t len, void *buf);
  93
  94 static inline void rpcif_enable_rpm(struct rpcif *rpc)
  95 {
  96         pm_runtime_enable(rpc->dev);
  97 }
  98
  99 static inline void rpcif_disable_rpm(struct rpcif *rpc)
 100 {
 101         pm_runtime_disable(rpc->dev);
 102 }
 103
 104 #endif // __RENESAS_RPC_IF_H