rsmu_spi.c 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * SPI driver for Renesas Synchronization Management Unit (SMU) devices.
  4. *
  5. * Copyright (C) 2021 Integrated Device Technology, Inc., a Renesas Company.
  6. */
  7. #include <linux/init.h>
  8. #include <linux/kernel.h>
  9. #include <linux/mfd/core.h>
  10. #include <linux/mfd/rsmu.h>
  11. #include <linux/module.h>
  12. #include <linux/of.h>
  13. #include <linux/regmap.h>
  14. #include <linux/slab.h>
  15. #include <linux/spi/spi.h>
  16. #include "rsmu.h"
  17. #define RSMU_CM_PAGE_ADDR 0x7C
  18. #define RSMU_SABRE_PAGE_ADDR 0x7F
  19. #define RSMU_HIGHER_ADDR_MASK 0xFF80
  20. #define RSMU_HIGHER_ADDR_SHIFT 7
  21. #define RSMU_LOWER_ADDR_MASK 0x7F
  22. static int rsmu_read_device(struct rsmu_ddata *rsmu, u8 reg, u8 *buf, u16 bytes)
  23. {
  24. struct spi_device *client = to_spi_device(rsmu->dev);
  25. struct spi_transfer xfer = {0};
  26. struct spi_message msg;
  27. u8 cmd[256] = {0};
  28. u8 rsp[256] = {0};
  29. int ret;
  30. cmd[0] = reg | 0x80;
  31. xfer.rx_buf = rsp;
  32. xfer.len = bytes + 1;
  33. xfer.tx_buf = cmd;
  34. xfer.bits_per_word = client->bits_per_word;
  35. xfer.speed_hz = client->max_speed_hz;
  36. spi_message_init(&msg);
  37. spi_message_add_tail(&xfer, &msg);
  38. /*
  39. * 4-wire SPI is a shift register, so for every byte you send,
  40. * you get one back at the same time. Example read from 0xC024,
  41. * which has value of 0x2D
  42. *
  43. * MOSI:
  44. * 7C 00 C0 #Set page register
  45. * A4 00 #MSB is set, so this is read command
  46. * MISO:
  47. * XX 2D #XX is a dummy byte from sending A4 and we
  48. * need to throw it away
  49. */
  50. ret = spi_sync(client, &msg);
  51. if (ret >= 0)
  52. memcpy(buf, &rsp[1], xfer.len-1);
  53. return ret;
  54. }
  55. static int rsmu_write_device(struct rsmu_ddata *rsmu, u8 reg, u8 *buf, u16 bytes)
  56. {
  57. struct spi_device *client = to_spi_device(rsmu->dev);
  58. struct spi_transfer xfer = {0};
  59. struct spi_message msg;
  60. u8 cmd[256] = {0};
  61. cmd[0] = reg;
  62. memcpy(&cmd[1], buf, bytes);
  63. xfer.len = bytes + 1;
  64. xfer.tx_buf = cmd;
  65. xfer.bits_per_word = client->bits_per_word;
  66. xfer.speed_hz = client->max_speed_hz;
  67. spi_message_init(&msg);
  68. spi_message_add_tail(&xfer, &msg);
  69. return spi_sync(client, &msg);
  70. }
  71. /*
  72. * 1-byte (1B) offset addressing:
  73. * 16-bit register address: the lower 7 bits of the register address come
  74. * from the offset addr byte and the upper 9 bits come from the page register.
  75. */
  76. static int rsmu_write_page_register(struct rsmu_ddata *rsmu, u16 reg)
  77. {
  78. u8 page_reg;
  79. u8 buf[2];
  80. u16 bytes;
  81. u16 page;
  82. int err;
  83. switch (rsmu->type) {
  84. case RSMU_CM:
  85. page_reg = RSMU_CM_PAGE_ADDR;
  86. page = reg & RSMU_HIGHER_ADDR_MASK;
  87. buf[0] = (u8)(page & 0xff);
  88. buf[1] = (u8)((page >> 8) & 0xff);
  89. bytes = 2;
  90. break;
  91. case RSMU_SABRE:
  92. page_reg = RSMU_SABRE_PAGE_ADDR;
  93. page = reg >> RSMU_HIGHER_ADDR_SHIFT;
  94. buf[0] = (u8)(page & 0xff);
  95. bytes = 1;
  96. break;
  97. default:
  98. dev_err(rsmu->dev, "Unsupported RSMU device type: %d\n", rsmu->type);
  99. return -ENODEV;
  100. }
  101. /* Simply return if we are on the same page */
  102. if (rsmu->page == page)
  103. return 0;
  104. err = rsmu_write_device(rsmu, page_reg, buf, bytes);
  105. if (err)
  106. dev_err(rsmu->dev, "Failed to set page offset 0x%x\n", page);
  107. else
  108. /* Remember the last page */
  109. rsmu->page = page;
  110. return err;
  111. }
  112. static int rsmu_reg_read(void *context, unsigned int reg, unsigned int *val)
  113. {
  114. struct rsmu_ddata *rsmu = spi_get_drvdata((struct spi_device *)context);
  115. u8 addr = (u8)(reg & RSMU_LOWER_ADDR_MASK);
  116. int err;
  117. err = rsmu_write_page_register(rsmu, reg);
  118. if (err)
  119. return err;
  120. err = rsmu_read_device(rsmu, addr, (u8 *)val, 1);
  121. if (err)
  122. dev_err(rsmu->dev, "Failed to read offset address 0x%x\n", addr);
  123. return err;
  124. }
  125. static int rsmu_reg_write(void *context, unsigned int reg, unsigned int val)
  126. {
  127. struct rsmu_ddata *rsmu = spi_get_drvdata((struct spi_device *)context);
  128. u8 addr = (u8)(reg & RSMU_LOWER_ADDR_MASK);
  129. u8 data = (u8)val;
  130. int err;
  131. err = rsmu_write_page_register(rsmu, reg);
  132. if (err)
  133. return err;
  134. err = rsmu_write_device(rsmu, addr, &data, 1);
  135. if (err)
  136. dev_err(rsmu->dev,
  137. "Failed to write offset address 0x%x\n", addr);
  138. return err;
  139. }
  140. static const struct regmap_config rsmu_cm_regmap_config = {
  141. .reg_bits = 16,
  142. .val_bits = 8,
  143. .max_register = 0xD000,
  144. .reg_read = rsmu_reg_read,
  145. .reg_write = rsmu_reg_write,
  146. .cache_type = REGCACHE_NONE,
  147. };
  148. static const struct regmap_config rsmu_sabre_regmap_config = {
  149. .reg_bits = 16,
  150. .val_bits = 8,
  151. .max_register = 0x400,
  152. .reg_read = rsmu_reg_read,
  153. .reg_write = rsmu_reg_write,
  154. .cache_type = REGCACHE_NONE,
  155. };
  156. static int rsmu_spi_probe(struct spi_device *client)
  157. {
  158. const struct spi_device_id *id = spi_get_device_id(client);
  159. const struct regmap_config *cfg;
  160. struct rsmu_ddata *rsmu;
  161. int ret;
  162. rsmu = devm_kzalloc(&client->dev, sizeof(*rsmu), GFP_KERNEL);
  163. if (!rsmu)
  164. return -ENOMEM;
  165. spi_set_drvdata(client, rsmu);
  166. rsmu->dev = &client->dev;
  167. rsmu->type = (enum rsmu_type)id->driver_data;
  168. /* Initialize regmap */
  169. switch (rsmu->type) {
  170. case RSMU_CM:
  171. cfg = &rsmu_cm_regmap_config;
  172. break;
  173. case RSMU_SABRE:
  174. cfg = &rsmu_sabre_regmap_config;
  175. break;
  176. default:
  177. dev_err(rsmu->dev, "Unsupported RSMU device type: %d\n", rsmu->type);
  178. return -ENODEV;
  179. }
  180. rsmu->regmap = devm_regmap_init(&client->dev, NULL, client, cfg);
  181. if (IS_ERR(rsmu->regmap)) {
  182. ret = PTR_ERR(rsmu->regmap);
  183. dev_err(rsmu->dev, "Failed to allocate register map: %d\n", ret);
  184. return ret;
  185. }
  186. return rsmu_core_init(rsmu);
  187. }
  188. static void rsmu_spi_remove(struct spi_device *client)
  189. {
  190. struct rsmu_ddata *rsmu = spi_get_drvdata(client);
  191. rsmu_core_exit(rsmu);
  192. }
  193. static const struct spi_device_id rsmu_spi_id[] = {
  194. { "8a34000", RSMU_CM },
  195. { "8a34001", RSMU_CM },
  196. { "82p33810", RSMU_SABRE },
  197. { "82p33811", RSMU_SABRE },
  198. {}
  199. };
  200. MODULE_DEVICE_TABLE(spi, rsmu_spi_id);
  201. static const struct of_device_id rsmu_spi_of_match[] = {
  202. { .compatible = "idt,8a34000", .data = (void *)RSMU_CM },
  203. { .compatible = "idt,8a34001", .data = (void *)RSMU_CM },
  204. { .compatible = "idt,82p33810", .data = (void *)RSMU_SABRE },
  205. { .compatible = "idt,82p33811", .data = (void *)RSMU_SABRE },
  206. {}
  207. };
  208. MODULE_DEVICE_TABLE(of, rsmu_spi_of_match);
  209. static struct spi_driver rsmu_spi_driver = {
  210. .driver = {
  211. .name = "rsmu-spi",
  212. .of_match_table = of_match_ptr(rsmu_spi_of_match),
  213. },
  214. .probe = rsmu_spi_probe,
  215. .remove = rsmu_spi_remove,
  216. .id_table = rsmu_spi_id,
  217. };
  218. static int __init rsmu_spi_init(void)
  219. {
  220. return spi_register_driver(&rsmu_spi_driver);
  221. }
  222. subsys_initcall(rsmu_spi_init);
  223. static void __exit rsmu_spi_exit(void)
  224. {
  225. spi_unregister_driver(&rsmu_spi_driver);
  226. }
  227. module_exit(rsmu_spi_exit);
  228. MODULE_DESCRIPTION("Renesas SMU SPI driver");
  229. MODULE_LICENSE("GPL");