oxygen_io.c 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * C-Media CMI8788 driver - helper functions
  4. *
  5. * Copyright (c) Clemens Ladisch <[email protected]>
  6. */
  7. #include <linux/delay.h>
  8. #include <linux/sched.h>
  9. #include <linux/export.h>
  10. #include <linux/io.h>
  11. #include <sound/core.h>
  12. #include <sound/mpu401.h>
  13. #include "oxygen.h"
  14. u8 oxygen_read8(struct oxygen *chip, unsigned int reg)
  15. {
  16. return inb(chip->addr + reg);
  17. }
  18. EXPORT_SYMBOL(oxygen_read8);
  19. u16 oxygen_read16(struct oxygen *chip, unsigned int reg)
  20. {
  21. return inw(chip->addr + reg);
  22. }
  23. EXPORT_SYMBOL(oxygen_read16);
  24. u32 oxygen_read32(struct oxygen *chip, unsigned int reg)
  25. {
  26. return inl(chip->addr + reg);
  27. }
  28. EXPORT_SYMBOL(oxygen_read32);
  29. void oxygen_write8(struct oxygen *chip, unsigned int reg, u8 value)
  30. {
  31. outb(value, chip->addr + reg);
  32. chip->saved_registers._8[reg] = value;
  33. }
  34. EXPORT_SYMBOL(oxygen_write8);
  35. void oxygen_write16(struct oxygen *chip, unsigned int reg, u16 value)
  36. {
  37. outw(value, chip->addr + reg);
  38. chip->saved_registers._16[reg / 2] = cpu_to_le16(value);
  39. }
  40. EXPORT_SYMBOL(oxygen_write16);
  41. void oxygen_write32(struct oxygen *chip, unsigned int reg, u32 value)
  42. {
  43. outl(value, chip->addr + reg);
  44. chip->saved_registers._32[reg / 4] = cpu_to_le32(value);
  45. }
  46. EXPORT_SYMBOL(oxygen_write32);
  47. void oxygen_write8_masked(struct oxygen *chip, unsigned int reg,
  48. u8 value, u8 mask)
  49. {
  50. u8 tmp = inb(chip->addr + reg);
  51. tmp &= ~mask;
  52. tmp |= value & mask;
  53. outb(tmp, chip->addr + reg);
  54. chip->saved_registers._8[reg] = tmp;
  55. }
  56. EXPORT_SYMBOL(oxygen_write8_masked);
  57. void oxygen_write16_masked(struct oxygen *chip, unsigned int reg,
  58. u16 value, u16 mask)
  59. {
  60. u16 tmp = inw(chip->addr + reg);
  61. tmp &= ~mask;
  62. tmp |= value & mask;
  63. outw(tmp, chip->addr + reg);
  64. chip->saved_registers._16[reg / 2] = cpu_to_le16(tmp);
  65. }
  66. EXPORT_SYMBOL(oxygen_write16_masked);
  67. void oxygen_write32_masked(struct oxygen *chip, unsigned int reg,
  68. u32 value, u32 mask)
  69. {
  70. u32 tmp = inl(chip->addr + reg);
  71. tmp &= ~mask;
  72. tmp |= value & mask;
  73. outl(tmp, chip->addr + reg);
  74. chip->saved_registers._32[reg / 4] = cpu_to_le32(tmp);
  75. }
  76. EXPORT_SYMBOL(oxygen_write32_masked);
  77. static int oxygen_ac97_wait(struct oxygen *chip, unsigned int mask)
  78. {
  79. u8 status = 0;
  80. /*
  81. * Reading the status register also clears the bits, so we have to save
  82. * the read bits in status.
  83. */
  84. wait_event_timeout(chip->ac97_waitqueue,
  85. ({ status |= oxygen_read8(chip, OXYGEN_AC97_INTERRUPT_STATUS);
  86. status & mask; }),
  87. msecs_to_jiffies(1) + 1);
  88. /*
  89. * Check even after a timeout because this function should not require
  90. * the AC'97 interrupt to be enabled.
  91. */
  92. status |= oxygen_read8(chip, OXYGEN_AC97_INTERRUPT_STATUS);
  93. return status & mask ? 0 : -EIO;
  94. }
  95. /*
  96. * About 10% of AC'97 register reads or writes fail to complete, but even those
  97. * where the controller indicates completion aren't guaranteed to have actually
  98. * happened.
  99. *
  100. * It's hard to assign blame to either the controller or the codec because both
  101. * were made by C-Media ...
  102. */
  103. void oxygen_write_ac97(struct oxygen *chip, unsigned int codec,
  104. unsigned int index, u16 data)
  105. {
  106. unsigned int count, succeeded;
  107. u32 reg;
  108. reg = data;
  109. reg |= index << OXYGEN_AC97_REG_ADDR_SHIFT;
  110. reg |= OXYGEN_AC97_REG_DIR_WRITE;
  111. reg |= codec << OXYGEN_AC97_REG_CODEC_SHIFT;
  112. succeeded = 0;
  113. for (count = 5; count > 0; --count) {
  114. udelay(5);
  115. oxygen_write32(chip, OXYGEN_AC97_REGS, reg);
  116. /* require two "completed" writes, just to be sure */
  117. if (oxygen_ac97_wait(chip, OXYGEN_AC97_INT_WRITE_DONE) >= 0 &&
  118. ++succeeded >= 2) {
  119. chip->saved_ac97_registers[codec][index / 2] = data;
  120. return;
  121. }
  122. }
  123. dev_err(chip->card->dev, "AC'97 write timeout\n");
  124. }
  125. EXPORT_SYMBOL(oxygen_write_ac97);
  126. u16 oxygen_read_ac97(struct oxygen *chip, unsigned int codec,
  127. unsigned int index)
  128. {
  129. unsigned int count;
  130. unsigned int last_read = UINT_MAX;
  131. u32 reg;
  132. reg = index << OXYGEN_AC97_REG_ADDR_SHIFT;
  133. reg |= OXYGEN_AC97_REG_DIR_READ;
  134. reg |= codec << OXYGEN_AC97_REG_CODEC_SHIFT;
  135. for (count = 5; count > 0; --count) {
  136. udelay(5);
  137. oxygen_write32(chip, OXYGEN_AC97_REGS, reg);
  138. udelay(10);
  139. if (oxygen_ac97_wait(chip, OXYGEN_AC97_INT_READ_DONE) >= 0) {
  140. u16 value = oxygen_read16(chip, OXYGEN_AC97_REGS);
  141. /* we require two consecutive reads of the same value */
  142. if (value == last_read)
  143. return value;
  144. last_read = value;
  145. /*
  146. * Invert the register value bits to make sure that two
  147. * consecutive unsuccessful reads do not return the same
  148. * value.
  149. */
  150. reg ^= 0xffff;
  151. }
  152. }
  153. dev_err(chip->card->dev, "AC'97 read timeout on codec %u\n", codec);
  154. return 0;
  155. }
  156. EXPORT_SYMBOL(oxygen_read_ac97);
  157. void oxygen_write_ac97_masked(struct oxygen *chip, unsigned int codec,
  158. unsigned int index, u16 data, u16 mask)
  159. {
  160. u16 value = oxygen_read_ac97(chip, codec, index);
  161. value &= ~mask;
  162. value |= data & mask;
  163. oxygen_write_ac97(chip, codec, index, value);
  164. }
  165. EXPORT_SYMBOL(oxygen_write_ac97_masked);
  166. static int oxygen_wait_spi(struct oxygen *chip)
  167. {
  168. unsigned int count;
  169. /*
  170. * Higher timeout to be sure: 200 us;
  171. * actual transaction should not need more than 40 us.
  172. */
  173. for (count = 50; count > 0; count--) {
  174. udelay(4);
  175. if ((oxygen_read8(chip, OXYGEN_SPI_CONTROL) &
  176. OXYGEN_SPI_BUSY) == 0)
  177. return 0;
  178. }
  179. dev_err(chip->card->dev, "oxygen: SPI wait timeout\n");
  180. return -EIO;
  181. }
  182. int oxygen_write_spi(struct oxygen *chip, u8 control, unsigned int data)
  183. {
  184. /*
  185. * We need to wait AFTER initiating the SPI transaction,
  186. * otherwise read operations will not work.
  187. */
  188. oxygen_write8(chip, OXYGEN_SPI_DATA1, data);
  189. oxygen_write8(chip, OXYGEN_SPI_DATA2, data >> 8);
  190. if (control & OXYGEN_SPI_DATA_LENGTH_3)
  191. oxygen_write8(chip, OXYGEN_SPI_DATA3, data >> 16);
  192. oxygen_write8(chip, OXYGEN_SPI_CONTROL, control);
  193. return oxygen_wait_spi(chip);
  194. }
  195. EXPORT_SYMBOL(oxygen_write_spi);
  196. void oxygen_write_i2c(struct oxygen *chip, u8 device, u8 map, u8 data)
  197. {
  198. /* should not need more than about 300 us */
  199. msleep(1);
  200. oxygen_write8(chip, OXYGEN_2WIRE_MAP, map);
  201. oxygen_write8(chip, OXYGEN_2WIRE_DATA, data);
  202. oxygen_write8(chip, OXYGEN_2WIRE_CONTROL,
  203. device | OXYGEN_2WIRE_DIR_WRITE);
  204. }
  205. EXPORT_SYMBOL(oxygen_write_i2c);
  206. static void _write_uart(struct oxygen *chip, unsigned int port, u8 data)
  207. {
  208. if (oxygen_read8(chip, OXYGEN_MPU401 + 1) & MPU401_TX_FULL)
  209. msleep(1);
  210. oxygen_write8(chip, OXYGEN_MPU401 + port, data);
  211. }
  212. void oxygen_reset_uart(struct oxygen *chip)
  213. {
  214. _write_uart(chip, 1, MPU401_RESET);
  215. msleep(1); /* wait for ACK */
  216. _write_uart(chip, 1, MPU401_ENTER_UART);
  217. }
  218. EXPORT_SYMBOL(oxygen_reset_uart);
  219. void oxygen_write_uart(struct oxygen *chip, u8 data)
  220. {
  221. _write_uart(chip, 0, data);
  222. }
  223. EXPORT_SYMBOL(oxygen_write_uart);
  224. u16 oxygen_read_eeprom(struct oxygen *chip, unsigned int index)
  225. {
  226. unsigned int timeout;
  227. oxygen_write8(chip, OXYGEN_EEPROM_CONTROL,
  228. index | OXYGEN_EEPROM_DIR_READ);
  229. for (timeout = 0; timeout < 100; ++timeout) {
  230. udelay(1);
  231. if (!(oxygen_read8(chip, OXYGEN_EEPROM_STATUS)
  232. & OXYGEN_EEPROM_BUSY))
  233. break;
  234. }
  235. return oxygen_read16(chip, OXYGEN_EEPROM_DATA);
  236. }
  237. void oxygen_write_eeprom(struct oxygen *chip, unsigned int index, u16 value)
  238. {
  239. unsigned int timeout;
  240. oxygen_write16(chip, OXYGEN_EEPROM_DATA, value);
  241. oxygen_write8(chip, OXYGEN_EEPROM_CONTROL,
  242. index | OXYGEN_EEPROM_DIR_WRITE);
  243. for (timeout = 0; timeout < 10; ++timeout) {
  244. msleep(1);
  245. if (!(oxygen_read8(chip, OXYGEN_EEPROM_STATUS)
  246. & OXYGEN_EEPROM_BUSY))
  247. return;
  248. }
  249. dev_err(chip->card->dev, "EEPROM write timeout\n");
  250. }