w1_io.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  1. /*
  2. * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
  3. *
  4. * This program is free software; you can redistribute it and/or modify
  5. * it under the terms of the GNU General Public License as published by
  6. * the Free Software Foundation; either version 2 of the License, or
  7. * (at your option) any later version.
  8. *
  9. * This program is distributed in the hope that it will be useful,
  10. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. * GNU General Public License for more details.
  13. */
  14. #include <asm/io.h>
  15. #include <linux/delay.h>
  16. #include <linux/moduleparam.h>
  17. #include <linux/module.h>
  18. #include "w1_internal.h"
  19. static int w1_delay_parm = 1;
  20. module_param_named(delay_coef, w1_delay_parm, int, 0);
  21. static int w1_disable_irqs = 0;
  22. module_param_named(disable_irqs, w1_disable_irqs, int, 0);
  23. static u8 w1_crc8_table[] = {
  24. 0, 94, 188, 226, 97, 63, 221, 131, 194, 156, 126, 32, 163, 253, 31, 65,
  25. 157, 195, 33, 127, 252, 162, 64, 30, 95, 1, 227, 189, 62, 96, 130, 220,
  26. 35, 125, 159, 193, 66, 28, 254, 160, 225, 191, 93, 3, 128, 222, 60, 98,
  27. 190, 224, 2, 92, 223, 129, 99, 61, 124, 34, 192, 158, 29, 67, 161, 255,
  28. 70, 24, 250, 164, 39, 121, 155, 197, 132, 218, 56, 102, 229, 187, 89, 7,
  29. 219, 133, 103, 57, 186, 228, 6, 88, 25, 71, 165, 251, 120, 38, 196, 154,
  30. 101, 59, 217, 135, 4, 90, 184, 230, 167, 249, 27, 69, 198, 152, 122, 36,
  31. 248, 166, 68, 26, 153, 199, 37, 123, 58, 100, 134, 216, 91, 5, 231, 185,
  32. 140, 210, 48, 110, 237, 179, 81, 15, 78, 16, 242, 172, 47, 113, 147, 205,
  33. 17, 79, 173, 243, 112, 46, 204, 146, 211, 141, 111, 49, 178, 236, 14, 80,
  34. 175, 241, 19, 77, 206, 144, 114, 44, 109, 51, 209, 143, 12, 82, 176, 238,
  35. 50, 108, 142, 208, 83, 13, 239, 177, 240, 174, 76, 18, 145, 207, 45, 115,
  36. 202, 148, 118, 40, 171, 245, 23, 73, 8, 86, 180, 234, 105, 55, 213, 139,
  37. 87, 9, 235, 181, 54, 104, 138, 212, 149, 203, 41, 119, 244, 170, 72, 22,
  38. 233, 183, 85, 11, 136, 214, 52, 106, 43, 117, 151, 201, 74, 20, 246, 168,
  39. 116, 42, 200, 150, 21, 75, 169, 247, 182, 232, 10, 84, 215, 137, 107, 53
  40. };
  41. static void w1_delay(unsigned long tm)
  42. {
  43. udelay(tm * w1_delay_parm);
  44. }
  45. static void w1_write_bit(struct w1_master *dev, int bit);
  46. static u8 w1_read_bit(struct w1_master *dev);
  47. /**
  48. * w1_touch_bit() - Generates a write-0 or write-1 cycle and samples the level.
  49. * @dev: the master device
  50. * @bit: 0 - write a 0, 1 - write a 0 read the level
  51. */
  52. static u8 w1_touch_bit(struct w1_master *dev, int bit)
  53. {
  54. if (dev->bus_master->touch_bit)
  55. return dev->bus_master->touch_bit(dev->bus_master->data, bit);
  56. else if (bit)
  57. return w1_read_bit(dev);
  58. else {
  59. w1_write_bit(dev, 0);
  60. return 0;
  61. }
  62. }
  63. /**
  64. * w1_write_bit() - Generates a write-0 or write-1 cycle.
  65. * @dev: the master device
  66. * @bit: bit to write
  67. *
  68. * Only call if dev->bus_master->touch_bit is NULL
  69. */
  70. static void w1_write_bit(struct w1_master *dev, int bit)
  71. {
  72. unsigned long flags = 0;
  73. if(w1_disable_irqs) local_irq_save(flags);
  74. if (bit) {
  75. dev->bus_master->write_bit(dev->bus_master->data, 0);
  76. w1_delay(6);
  77. dev->bus_master->write_bit(dev->bus_master->data, 1);
  78. w1_delay(64);
  79. } else {
  80. dev->bus_master->write_bit(dev->bus_master->data, 0);
  81. w1_delay(60);
  82. dev->bus_master->write_bit(dev->bus_master->data, 1);
  83. w1_delay(10);
  84. }
  85. if(w1_disable_irqs) local_irq_restore(flags);
  86. }
  87. /**
  88. * w1_pre_write() - pre-write operations
  89. * @dev: the master device
  90. *
  91. * Pre-write operation, currently only supporting strong pullups.
  92. * Program the hardware for a strong pullup, if one has been requested and
  93. * the hardware supports it.
  94. */
  95. static void w1_pre_write(struct w1_master *dev)
  96. {
  97. if (dev->pullup_duration &&
  98. dev->enable_pullup && dev->bus_master->set_pullup) {
  99. dev->bus_master->set_pullup(dev->bus_master->data,
  100. dev->pullup_duration);
  101. }
  102. }
  103. /**
  104. * w1_post_write() - post-write options
  105. * @dev: the master device
  106. *
  107. * Post-write operation, currently only supporting strong pullups.
  108. * If a strong pullup was requested, clear it if the hardware supports
  109. * them, or execute the delay otherwise, in either case clear the request.
  110. */
  111. static void w1_post_write(struct w1_master *dev)
  112. {
  113. if (dev->pullup_duration) {
  114. if (dev->enable_pullup && dev->bus_master->set_pullup)
  115. dev->bus_master->set_pullup(dev->bus_master->data, 0);
  116. else
  117. msleep(dev->pullup_duration);
  118. dev->pullup_duration = 0;
  119. }
  120. }
  121. /**
  122. * w1_write_8() - Writes 8 bits.
  123. * @dev: the master device
  124. * @byte: the byte to write
  125. */
  126. void w1_write_8(struct w1_master *dev, u8 byte)
  127. {
  128. int i;
  129. if (dev->bus_master->write_byte) {
  130. w1_pre_write(dev);
  131. dev->bus_master->write_byte(dev->bus_master->data, byte);
  132. }
  133. else
  134. for (i = 0; i < 8; ++i) {
  135. if (i == 7)
  136. w1_pre_write(dev);
  137. w1_touch_bit(dev, (byte >> i) & 0x1);
  138. }
  139. w1_post_write(dev);
  140. }
  141. EXPORT_SYMBOL_GPL(w1_write_8);
  142. /**
  143. * w1_read_bit() - Generates a write-1 cycle and samples the level.
  144. * @dev: the master device
  145. *
  146. * Only call if dev->bus_master->touch_bit is NULL
  147. */
  148. static u8 w1_read_bit(struct w1_master *dev)
  149. {
  150. int result;
  151. unsigned long flags = 0;
  152. /* sample timing is critical here */
  153. local_irq_save(flags);
  154. dev->bus_master->write_bit(dev->bus_master->data, 0);
  155. w1_delay(6);
  156. dev->bus_master->write_bit(dev->bus_master->data, 1);
  157. w1_delay(9);
  158. result = dev->bus_master->read_bit(dev->bus_master->data);
  159. local_irq_restore(flags);
  160. w1_delay(55);
  161. return result & 0x1;
  162. }
  163. /**
  164. * w1_triplet() - * Does a triplet - used for searching ROM addresses.
  165. * @dev: the master device
  166. * @bdir: the bit to write if both id_bit and comp_bit are 0
  167. *
  168. * Return bits:
  169. * bit 0 = id_bit
  170. * bit 1 = comp_bit
  171. * bit 2 = dir_taken
  172. * If both bits 0 & 1 are set, the search should be restarted.
  173. *
  174. * Return: bit fields - see above
  175. */
  176. u8 w1_triplet(struct w1_master *dev, int bdir)
  177. {
  178. if (dev->bus_master->triplet)
  179. return dev->bus_master->triplet(dev->bus_master->data, bdir);
  180. else {
  181. u8 id_bit = w1_touch_bit(dev, 1);
  182. u8 comp_bit = w1_touch_bit(dev, 1);
  183. u8 retval;
  184. if (id_bit && comp_bit)
  185. return 0x03; /* error */
  186. if (!id_bit && !comp_bit) {
  187. /* Both bits are valid, take the direction given */
  188. retval = bdir ? 0x04 : 0;
  189. } else {
  190. /* Only one bit is valid, take that direction */
  191. bdir = id_bit;
  192. retval = id_bit ? 0x05 : 0x02;
  193. }
  194. if (dev->bus_master->touch_bit)
  195. w1_touch_bit(dev, bdir);
  196. else
  197. w1_write_bit(dev, bdir);
  198. return retval;
  199. }
  200. }
  201. EXPORT_SYMBOL_GPL(w1_triplet);
  202. /**
  203. * w1_read_8() - Reads 8 bits.
  204. * @dev: the master device
  205. *
  206. * Return: the byte read
  207. */
  208. u8 w1_read_8(struct w1_master *dev)
  209. {
  210. int i;
  211. u8 res = 0;
  212. if (dev->bus_master->read_byte)
  213. res = dev->bus_master->read_byte(dev->bus_master->data);
  214. else
  215. for (i = 0; i < 8; ++i)
  216. res |= (w1_touch_bit(dev,1) << i);
  217. return res;
  218. }
  219. EXPORT_SYMBOL_GPL(w1_read_8);
  220. /**
  221. * w1_write_block() - Writes a series of bytes.
  222. * @dev: the master device
  223. * @buf: pointer to the data to write
  224. * @len: the number of bytes to write
  225. */
  226. void w1_write_block(struct w1_master *dev, const u8 *buf, int len)
  227. {
  228. int i;
  229. if (dev->bus_master->write_block) {
  230. w1_pre_write(dev);
  231. dev->bus_master->write_block(dev->bus_master->data, buf, len);
  232. }
  233. else
  234. for (i = 0; i < len; ++i)
  235. w1_write_8(dev, buf[i]); /* calls w1_pre_write */
  236. w1_post_write(dev);
  237. }
  238. EXPORT_SYMBOL_GPL(w1_write_block);
  239. /**
  240. * w1_touch_block() - Touches a series of bytes.
  241. * @dev: the master device
  242. * @buf: pointer to the data to write
  243. * @len: the number of bytes to write
  244. */
  245. void w1_touch_block(struct w1_master *dev, u8 *buf, int len)
  246. {
  247. int i, j;
  248. u8 tmp;
  249. for (i = 0; i < len; ++i) {
  250. tmp = 0;
  251. for (j = 0; j < 8; ++j) {
  252. if (j == 7)
  253. w1_pre_write(dev);
  254. tmp |= w1_touch_bit(dev, (buf[i] >> j) & 0x1) << j;
  255. }
  256. buf[i] = tmp;
  257. }
  258. }
  259. EXPORT_SYMBOL_GPL(w1_touch_block);
  260. /**
  261. * w1_read_block() - Reads a series of bytes.
  262. * @dev: the master device
  263. * @buf: pointer to the buffer to fill
  264. * @len: the number of bytes to read
  265. * Return: the number of bytes read
  266. */
  267. u8 w1_read_block(struct w1_master *dev, u8 *buf, int len)
  268. {
  269. int i;
  270. u8 ret;
  271. if (dev->bus_master->read_block)
  272. ret = dev->bus_master->read_block(dev->bus_master->data, buf, len);
  273. else {
  274. for (i = 0; i < len; ++i)
  275. buf[i] = w1_read_8(dev);
  276. ret = len;
  277. }
  278. return ret;
  279. }
  280. EXPORT_SYMBOL_GPL(w1_read_block);
  281. /**
  282. * w1_reset_bus() - Issues a reset bus sequence.
  283. * @dev: the master device
  284. * Return: 0=Device present, 1=No device present or error
  285. */
  286. int w1_reset_bus(struct w1_master *dev)
  287. {
  288. int result;
  289. unsigned long flags = 0;
  290. if(w1_disable_irqs) local_irq_save(flags);
  291. if (dev->bus_master->reset_bus)
  292. result = dev->bus_master->reset_bus(dev->bus_master->data) & 0x1;
  293. else {
  294. dev->bus_master->write_bit(dev->bus_master->data, 0);
  295. /* minimum 480, max ? us
  296. * be nice and sleep, except 18b20 spec lists 960us maximum,
  297. * so until we can sleep with microsecond accuracy, spin.
  298. * Feel free to come up with some other way to give up the
  299. * cpu for such a short amount of time AND get it back in
  300. * the maximum amount of time.
  301. */
  302. w1_delay(500);
  303. dev->bus_master->write_bit(dev->bus_master->data, 1);
  304. w1_delay(70);
  305. result = dev->bus_master->read_bit(dev->bus_master->data) & 0x1;
  306. /* minimum 70 (above) + 430 = 500 us
  307. * There aren't any timing requirements between a reset and
  308. * the following transactions. Sleeping is safe here.
  309. */
  310. /* w1_delay(430); min required time */
  311. msleep(1);
  312. }
  313. if(w1_disable_irqs) local_irq_restore(flags);
  314. return result;
  315. }
  316. EXPORT_SYMBOL_GPL(w1_reset_bus);
  317. u8 w1_calc_crc8(u8 * data, int len)
  318. {
  319. u8 crc = 0;
  320. while (len--)
  321. crc = w1_crc8_table[crc ^ *data++];
  322. return crc;
  323. }
  324. EXPORT_SYMBOL_GPL(w1_calc_crc8);
  325. void w1_search_devices(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb)
  326. {
  327. dev->attempts++;
  328. if (dev->bus_master->search)
  329. dev->bus_master->search(dev->bus_master->data, dev,
  330. search_type, cb);
  331. else
  332. w1_search(dev, search_type, cb);
  333. }
  334. /**
  335. * w1_reset_select_slave() - reset and select a slave
  336. * @sl: the slave to select
  337. *
  338. * Resets the bus and then selects the slave by sending either a skip rom
  339. * or a rom match. A skip rom is issued if there is only one device
  340. * registered on the bus.
  341. * The w1 master lock must be held.
  342. *
  343. * Return: 0=success, anything else=error
  344. */
  345. int w1_reset_select_slave(struct w1_slave *sl)
  346. {
  347. if (w1_reset_bus(sl->master))
  348. return -1;
  349. if (sl->master->slave_count == 1)
  350. w1_write_8(sl->master, W1_SKIP_ROM);
  351. else {
  352. u8 match[9] = {W1_MATCH_ROM, };
  353. u64 rn = le64_to_cpu(*((u64*)&sl->reg_num));
  354. memcpy(&match[1], &rn, 8);
  355. w1_write_block(sl->master, match, 9);
  356. }
  357. return 0;
  358. }
  359. EXPORT_SYMBOL_GPL(w1_reset_select_slave);
  360. /**
  361. * w1_reset_resume_command() - resume instead of another match ROM
  362. * @dev: the master device
  363. *
  364. * When the workflow with a slave amongst many requires several
  365. * successive commands a reset between each, this function is similar
  366. * to doing a reset then a match ROM for the last matched ROM. The
  367. * advantage being that the matched ROM step is skipped in favor of the
  368. * resume command. The slave must support the command of course.
  369. *
  370. * If the bus has only one slave, traditionnaly the match ROM is skipped
  371. * and a "SKIP ROM" is done for efficiency. On multi-slave busses, this
  372. * doesn't work of course, but the resume command is the next best thing.
  373. *
  374. * The w1 master lock must be held.
  375. */
  376. int w1_reset_resume_command(struct w1_master *dev)
  377. {
  378. if (w1_reset_bus(dev))
  379. return -1;
  380. w1_write_8(dev, dev->slave_count > 1 ? W1_RESUME_CMD : W1_SKIP_ROM);
  381. return 0;
  382. }
  383. EXPORT_SYMBOL_GPL(w1_reset_resume_command);
  384. /**
  385. * w1_next_pullup() - register for a strong pullup
  386. * @dev: the master device
  387. * @delay: time in milliseconds
  388. *
  389. * Put out a strong pull-up of the specified duration after the next write
  390. * operation. Not all hardware supports strong pullups. Hardware that
  391. * doesn't support strong pullups will sleep for the given time after the
  392. * write operation without a strong pullup. This is a one shot request for
  393. * the next write, specifying zero will clear a previous request.
  394. * The w1 master lock must be held.
  395. *
  396. * Return: 0=success, anything else=error
  397. */
  398. void w1_next_pullup(struct w1_master *dev, int delay)
  399. {
  400. dev->pullup_duration = delay;
  401. }
  402. EXPORT_SYMBOL_GPL(w1_next_pullup);