bus.h 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  1. /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
  2. /* Copyright(c) 2015-17 Intel Corporation. */
  3. #ifndef __SDW_BUS_H
  4. #define __SDW_BUS_H
  5. #define DEFAULT_BANK_SWITCH_TIMEOUT 3000
  6. #define DEFAULT_PROBE_TIMEOUT 2000
  7. #if IS_ENABLED(CONFIG_ACPI)
  8. int sdw_acpi_find_slaves(struct sdw_bus *bus);
  9. #else
  10. static inline int sdw_acpi_find_slaves(struct sdw_bus *bus)
  11. {
  12. return -ENOTSUPP;
  13. }
  14. #endif
  15. int sdw_of_find_slaves(struct sdw_bus *bus);
  16. void sdw_extract_slave_id(struct sdw_bus *bus,
  17. u64 addr, struct sdw_slave_id *id);
  18. int sdw_slave_add(struct sdw_bus *bus, struct sdw_slave_id *id,
  19. struct fwnode_handle *fwnode);
  20. int sdw_master_device_add(struct sdw_bus *bus, struct device *parent,
  21. struct fwnode_handle *fwnode);
  22. int sdw_master_device_del(struct sdw_bus *bus);
  23. #ifdef CONFIG_DEBUG_FS
  24. void sdw_bus_debugfs_init(struct sdw_bus *bus);
  25. void sdw_bus_debugfs_exit(struct sdw_bus *bus);
  26. void sdw_slave_debugfs_init(struct sdw_slave *slave);
  27. void sdw_slave_debugfs_exit(struct sdw_slave *slave);
  28. void sdw_debugfs_init(void);
  29. void sdw_debugfs_exit(void);
  30. #else
  31. static inline void sdw_bus_debugfs_init(struct sdw_bus *bus) {}
  32. static inline void sdw_bus_debugfs_exit(struct sdw_bus *bus) {}
  33. static inline void sdw_slave_debugfs_init(struct sdw_slave *slave) {}
  34. static inline void sdw_slave_debugfs_exit(struct sdw_slave *slave) {}
  35. static inline void sdw_debugfs_init(void) {}
  36. static inline void sdw_debugfs_exit(void) {}
  37. #endif
  38. enum {
  39. SDW_MSG_FLAG_READ = 0,
  40. SDW_MSG_FLAG_WRITE,
  41. };
  42. /**
  43. * struct sdw_msg - Message structure
  44. * @addr: Register address accessed in the Slave
  45. * @len: number of messages
  46. * @dev_num: Slave device number
  47. * @addr_page1: SCP address page 1 Slave register
  48. * @addr_page2: SCP address page 2 Slave register
  49. * @flags: transfer flags, indicate if xfer is read or write
  50. * @buf: message data buffer
  51. * @ssp_sync: Send message at SSP (Stream Synchronization Point)
  52. * @page: address requires paging
  53. */
  54. struct sdw_msg {
  55. u16 addr;
  56. u16 len;
  57. u8 dev_num;
  58. u8 addr_page1;
  59. u8 addr_page2;
  60. u8 flags;
  61. u8 *buf;
  62. bool ssp_sync;
  63. bool page;
  64. };
  65. #define SDW_DOUBLE_RATE_FACTOR 2
  66. #define SDW_STRM_RATE_GROUPING 1
  67. extern int sdw_rows[SDW_FRAME_ROWS];
  68. extern int sdw_cols[SDW_FRAME_COLS];
  69. int sdw_find_row_index(int row);
  70. int sdw_find_col_index(int col);
  71. /**
  72. * sdw_port_runtime: Runtime port parameters for Master or Slave
  73. *
  74. * @num: Port number. For audio streams, valid port number ranges from
  75. * [1,14]
  76. * @ch_mask: Channel mask
  77. * @transport_params: Transport parameters
  78. * @port_params: Port parameters
  79. * @port_node: List node for Master or Slave port_list
  80. *
  81. * SoundWire spec has no mention of ports for Master interface but the
  82. * concept is logically extended.
  83. */
  84. struct sdw_port_runtime {
  85. int num;
  86. int ch_mask;
  87. struct sdw_transport_params transport_params;
  88. struct sdw_port_params port_params;
  89. struct list_head port_node;
  90. };
  91. /**
  92. * sdw_slave_runtime: Runtime Stream parameters for Slave
  93. *
  94. * @slave: Slave handle
  95. * @direction: Data direction for Slave
  96. * @ch_count: Number of channels handled by the Slave for
  97. * this stream
  98. * @m_rt_node: sdw_master_runtime list node
  99. * @port_list: List of Slave Ports configured for this stream
  100. */
  101. struct sdw_slave_runtime {
  102. struct sdw_slave *slave;
  103. enum sdw_data_direction direction;
  104. unsigned int ch_count;
  105. struct list_head m_rt_node;
  106. struct list_head port_list;
  107. };
  108. /**
  109. * sdw_master_runtime: Runtime stream parameters for Master
  110. *
  111. * @bus: Bus handle
  112. * @stream: Stream runtime handle
  113. * @direction: Data direction for Master
  114. * @ch_count: Number of channels handled by the Master for
  115. * this stream, can be zero.
  116. * @slave_rt_list: Slave runtime list
  117. * @port_list: List of Master Ports configured for this stream, can be zero.
  118. * @stream_node: sdw_stream_runtime master_list node
  119. * @bus_node: sdw_bus m_rt_list node
  120. */
  121. struct sdw_master_runtime {
  122. struct sdw_bus *bus;
  123. struct sdw_stream_runtime *stream;
  124. enum sdw_data_direction direction;
  125. unsigned int ch_count;
  126. struct list_head slave_rt_list;
  127. struct list_head port_list;
  128. struct list_head stream_node;
  129. struct list_head bus_node;
  130. };
  131. struct sdw_dpn_prop *sdw_get_slave_dpn_prop(struct sdw_slave *slave,
  132. enum sdw_data_direction direction,
  133. unsigned int port_num);
  134. int sdw_configure_dpn_intr(struct sdw_slave *slave, int port,
  135. bool enable, int mask);
  136. int sdw_transfer(struct sdw_bus *bus, struct sdw_msg *msg);
  137. int sdw_transfer_defer(struct sdw_bus *bus, struct sdw_msg *msg,
  138. struct sdw_defer *defer);
  139. #define SDW_READ_INTR_CLEAR_RETRY 10
  140. int sdw_fill_msg(struct sdw_msg *msg, struct sdw_slave *slave,
  141. u32 addr, size_t count, u16 dev_num, u8 flags, u8 *buf);
  142. /* Retrieve and return channel count from channel mask */
  143. static inline int sdw_ch_mask_to_ch(int ch_mask)
  144. {
  145. int c = 0;
  146. for (c = 0; ch_mask; ch_mask >>= 1)
  147. c += ch_mask & 1;
  148. return c;
  149. }
  150. /* Fill transport parameter data structure */
  151. static inline void sdw_fill_xport_params(struct sdw_transport_params *params,
  152. int port_num, bool grp_ctrl_valid,
  153. int grp_ctrl, int sample_int,
  154. int off1, int off2,
  155. int hstart, int hstop,
  156. int pack_mode, int lane_ctrl)
  157. {
  158. params->port_num = port_num;
  159. params->blk_grp_ctrl_valid = grp_ctrl_valid;
  160. params->blk_grp_ctrl = grp_ctrl;
  161. params->sample_interval = sample_int;
  162. params->offset1 = off1;
  163. params->offset2 = off2;
  164. params->hstart = hstart;
  165. params->hstop = hstop;
  166. params->blk_pkg_mode = pack_mode;
  167. params->lane_ctrl = lane_ctrl;
  168. }
  169. /* Fill port parameter data structure */
  170. static inline void sdw_fill_port_params(struct sdw_port_params *params,
  171. int port_num, int bps,
  172. int flow_mode, int data_mode)
  173. {
  174. params->num = port_num;
  175. params->bps = bps;
  176. params->flow_mode = flow_mode;
  177. params->data_mode = data_mode;
  178. }
  179. /* Read-Modify-Write Slave register */
  180. static inline int sdw_update(struct sdw_slave *slave, u32 addr, u8 mask, u8 val)
  181. {
  182. int tmp;
  183. tmp = sdw_read(slave, addr);
  184. if (tmp < 0)
  185. return tmp;
  186. tmp = (tmp & ~mask) | val;
  187. return sdw_write(slave, addr, tmp);
  188. }
  189. /* broadcast read/write for tests */
  190. int sdw_bread_no_pm_unlocked(struct sdw_bus *bus, u16 dev_num, u32 addr);
  191. int sdw_bwrite_no_pm_unlocked(struct sdw_bus *bus, u16 dev_num, u32 addr, u8 value);
  192. /*
  193. * At the moment we only track Master-initiated hw_reset.
  194. * Additional fields can be added as needed
  195. */
  196. #define SDW_UNATTACH_REQUEST_MASTER_RESET BIT(0)
  197. void sdw_clear_slave_status(struct sdw_bus *bus, u32 request);
  198. int sdw_slave_modalias(const struct sdw_slave *slave, char *buf, size_t size);
  199. #endif /* __SDW_BUS_H */