fsi-master.h 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * FSI master definitions. These comprise the core <--> master interface,
  4. * to allow the core to interact with the (hardware-specific) masters.
  5. *
  6. * Copyright (C) IBM Corporation 2016
  7. */
  8. #ifndef DRIVERS_FSI_MASTER_H
  9. #define DRIVERS_FSI_MASTER_H
  10. #include <linux/device.h>
  11. #include <linux/mutex.h>
  12. /*
  13. * Master registers
  14. *
  15. * These are used by hardware masters, such as the one in the FSP2, AST2600 and
  16. * the hub master in POWER processors.
  17. */
  18. /* Control Registers */
  19. #define FSI_MMODE 0x0 /* R/W: mode */
  20. #define FSI_MDLYR 0x4 /* R/W: delay */
  21. #define FSI_MCRSP 0x8 /* R/W: clock rate */
  22. #define FSI_MENP0 0x10 /* R/W: enable */
  23. #define FSI_MLEVP0 0x18 /* R: plug detect */
  24. #define FSI_MSENP0 0x18 /* S: Set enable */
  25. #define FSI_MCENP0 0x20 /* C: Clear enable */
  26. #define FSI_MAEB 0x70 /* R: Error address */
  27. #define FSI_MVER 0x74 /* R: master version/type */
  28. #define FSI_MSTAP0 0xd0 /* R: Port status */
  29. #define FSI_MRESP0 0xd0 /* W: Port reset */
  30. #define FSI_MESRB0 0x1d0 /* R: Master error status */
  31. #define FSI_MRESB0 0x1d0 /* W: Reset bridge */
  32. #define FSI_MSCSB0 0x1d4 /* R: Master sub command stack */
  33. #define FSI_MATRB0 0x1d8 /* R: Master address trace */
  34. #define FSI_MDTRB0 0x1dc /* R: Master data trace */
  35. #define FSI_MECTRL 0x2e0 /* W: Error control */
  36. /* MMODE: Mode control */
  37. #define FSI_MMODE_EIP 0x80000000 /* Enable interrupt polling */
  38. #define FSI_MMODE_ECRC 0x40000000 /* Enable error recovery */
  39. #define FSI_MMODE_RELA 0x20000000 /* Enable relative address commands */
  40. #define FSI_MMODE_EPC 0x10000000 /* Enable parity checking */
  41. #define FSI_MMODE_P8_TO_LSB 0x00000010 /* Timeout value LSB */
  42. /* MSB=1, LSB=0 is 0.8 ms */
  43. /* MSB=0, LSB=1 is 0.9 ms */
  44. #define FSI_MMODE_CRS0SHFT 18 /* Clk rate selection 0 shift */
  45. #define FSI_MMODE_CRS0MASK 0x3ff /* Clk rate selection 0 mask */
  46. #define FSI_MMODE_CRS1SHFT 8 /* Clk rate selection 1 shift */
  47. #define FSI_MMODE_CRS1MASK 0x3ff /* Clk rate selection 1 mask */
  48. /* MRESB: Reset brindge */
  49. #define FSI_MRESB_RST_GEN 0x80000000 /* General reset */
  50. #define FSI_MRESB_RST_ERR 0x40000000 /* Error Reset */
  51. /* MRESP: Reset port */
  52. #define FSI_MRESP_RST_ALL_MASTER 0x20000000 /* Reset all FSI masters */
  53. #define FSI_MRESP_RST_ALL_LINK 0x10000000 /* Reset all FSI port contr. */
  54. #define FSI_MRESP_RST_MCR 0x08000000 /* Reset FSI master reg. */
  55. #define FSI_MRESP_RST_PYE 0x04000000 /* Reset FSI parity error */
  56. #define FSI_MRESP_RST_ALL 0xfc000000 /* Reset any error */
  57. /* MECTRL: Error control */
  58. #define FSI_MECTRL_EOAE 0x8000 /* Enable machine check when */
  59. /* master 0 in error */
  60. #define FSI_MECTRL_P8_AUTO_TERM 0x4000 /* Auto terminate */
  61. #define FSI_HUB_LINK_OFFSET 0x80000
  62. #define FSI_HUB_LINK_SIZE 0x80000
  63. #define FSI_HUB_MASTER_MAX_LINKS 8
  64. /*
  65. * Protocol definitions
  66. *
  67. * These are used by low level masters that bit-bang out the protocol
  68. */
  69. /* Various protocol delays */
  70. #define FSI_ECHO_DELAY_CLOCKS 16 /* Number clocks for echo delay */
  71. #define FSI_SEND_DELAY_CLOCKS 16 /* Number clocks for send delay */
  72. #define FSI_PRE_BREAK_CLOCKS 50 /* Number clocks to prep for break */
  73. #define FSI_BREAK_CLOCKS 256 /* Number of clocks to issue break */
  74. #define FSI_POST_BREAK_CLOCKS 16000 /* Number clocks to set up cfam */
  75. #define FSI_INIT_CLOCKS 5000 /* Clock out any old data */
  76. #define FSI_MASTER_DPOLL_CLOCKS 50 /* < 21 will cause slave to hang */
  77. #define FSI_MASTER_EPOLL_CLOCKS 50 /* Number of clocks for E_POLL retry */
  78. /* Various retry maximums */
  79. #define FSI_CRC_ERR_RETRIES 10
  80. #define FSI_MASTER_MAX_BUSY 200
  81. #define FSI_MASTER_MTOE_COUNT 1000
  82. /* Command encodings */
  83. #define FSI_CMD_DPOLL 0x2
  84. #define FSI_CMD_EPOLL 0x3
  85. #define FSI_CMD_TERM 0x3f
  86. #define FSI_CMD_ABS_AR 0x4
  87. #define FSI_CMD_REL_AR 0x5
  88. #define FSI_CMD_SAME_AR 0x3 /* but only a 2-bit opcode... */
  89. /* Slave responses */
  90. #define FSI_RESP_ACK 0 /* Success */
  91. #define FSI_RESP_BUSY 1 /* Slave busy */
  92. #define FSI_RESP_ERRA 2 /* Any (misc) Error */
  93. #define FSI_RESP_ERRC 3 /* Slave reports master CRC error */
  94. /* Misc */
  95. #define FSI_CRC_SIZE 4
  96. /* fsi-master definition and flags */
  97. #define FSI_MASTER_FLAG_SWCLOCK 0x1
  98. /*
  99. * Structures and function prototypes
  100. *
  101. * These are common to all masters
  102. */
  103. struct fsi_master {
  104. struct device dev;
  105. int idx;
  106. int n_links;
  107. int flags;
  108. struct mutex scan_lock;
  109. int (*read)(struct fsi_master *, int link, uint8_t id,
  110. uint32_t addr, void *val, size_t size);
  111. int (*write)(struct fsi_master *, int link, uint8_t id,
  112. uint32_t addr, const void *val, size_t size);
  113. int (*term)(struct fsi_master *, int link, uint8_t id);
  114. int (*send_break)(struct fsi_master *, int link);
  115. int (*link_enable)(struct fsi_master *, int link,
  116. bool enable);
  117. int (*link_config)(struct fsi_master *, int link,
  118. u8 t_send_delay, u8 t_echo_delay);
  119. };
  120. #define dev_to_fsi_master(d) container_of(d, struct fsi_master, dev)
  121. /**
  122. * fsi_master registration & lifetime: the fsi_master_register() and
  123. * fsi_master_unregister() functions will take ownership of the master, and
  124. * ->dev in particular. The registration path performs a get_device(), which
  125. * takes the first reference on the device. Similarly, the unregistration path
  126. * performs a put_device(), which may well drop the last reference.
  127. *
  128. * This means that master implementations *may* need to hold their own
  129. * reference (via get_device()) on master->dev. In particular, if the device's
  130. * ->release callback frees the fsi_master, then fsi_master_unregister will
  131. * invoke this free if no other reference is held.
  132. *
  133. * The same applies for the error path of fsi_master_register; if the call
  134. * fails, dev->release will have been invoked.
  135. */
  136. extern int fsi_master_register(struct fsi_master *master);
  137. extern void fsi_master_unregister(struct fsi_master *master);
  138. extern int fsi_master_rescan(struct fsi_master *master);
  139. #endif /* DRIVERS_FSI_MASTER_H */