max6875.c 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216
  1. /*
  2. * max6875.c - driver for MAX6874/MAX6875
  3. *
  4. * Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
  5. *
  6. * Based on eeprom.c
  7. *
  8. * The MAX6875 has a bank of registers and two banks of EEPROM.
  9. * Address ranges are defined as follows:
  10. * * 0x0000 - 0x0046 = configuration registers
  11. * * 0x8000 - 0x8046 = configuration EEPROM
  12. * * 0x8100 - 0x82FF = user EEPROM
  13. *
  14. * This driver makes the user EEPROM available for read.
  15. *
  16. * The registers & config EEPROM should be accessed via i2c-dev.
  17. *
  18. * The MAX6875 ignores the lowest address bit, so each chip responds to
  19. * two addresses - 0x50/0x51 and 0x52/0x53.
  20. *
  21. * Note that the MAX6875 uses i2c_smbus_write_byte_data() to set the read
  22. * address, so this driver is destructive if loaded for the wrong EEPROM chip.
  23. *
  24. * This program is free software; you can redistribute it and/or modify
  25. * it under the terms of the GNU General Public License as published by
  26. * the Free Software Foundation; version 2 of the License.
  27. */
  28. #include <linux/kernel.h>
  29. #include <linux/init.h>
  30. #include <linux/module.h>
  31. #include <linux/slab.h>
  32. #include <linux/i2c.h>
  33. #include <linux/mutex.h>
  34. /* The MAX6875 can only read/write 16 bytes at a time */
  35. #define SLICE_SIZE 16
  36. #define SLICE_BITS 4
  37. /* USER EEPROM is at addresses 0x8100 - 0x82FF */
  38. #define USER_EEPROM_BASE 0x8100
  39. #define USER_EEPROM_SIZE 0x0200
  40. #define USER_EEPROM_SLICES 32
  41. /* MAX6875 commands */
  42. #define MAX6875_CMD_BLK_READ 0x84
  43. /* Each client has this additional data */
  44. struct max6875_data {
  45. struct i2c_client *fake_client;
  46. struct mutex update_lock;
  47. u32 valid;
  48. u8 data[USER_EEPROM_SIZE];
  49. unsigned long last_updated[USER_EEPROM_SLICES];
  50. };
  51. static void max6875_update_slice(struct i2c_client *client, int slice)
  52. {
  53. struct max6875_data *data = i2c_get_clientdata(client);
  54. int i, j, addr;
  55. u8 *buf;
  56. if (slice >= USER_EEPROM_SLICES)
  57. return;
  58. mutex_lock(&data->update_lock);
  59. buf = &data->data[slice << SLICE_BITS];
  60. if (!(data->valid & (1 << slice)) ||
  61. time_after(jiffies, data->last_updated[slice])) {
  62. dev_dbg(&client->dev, "Starting update of slice %u\n", slice);
  63. data->valid &= ~(1 << slice);
  64. addr = USER_EEPROM_BASE + (slice << SLICE_BITS);
  65. /* select the eeprom address */
  66. if (i2c_smbus_write_byte_data(client, addr >> 8, addr & 0xFF)) {
  67. dev_err(&client->dev, "address set failed\n");
  68. goto exit_up;
  69. }
  70. if (i2c_check_functionality(client->adapter,
  71. I2C_FUNC_SMBUS_READ_I2C_BLOCK)) {
  72. if (i2c_smbus_read_i2c_block_data(client,
  73. MAX6875_CMD_BLK_READ,
  74. SLICE_SIZE,
  75. buf) != SLICE_SIZE) {
  76. goto exit_up;
  77. }
  78. } else {
  79. for (i = 0; i < SLICE_SIZE; i++) {
  80. j = i2c_smbus_read_byte(client);
  81. if (j < 0) {
  82. goto exit_up;
  83. }
  84. buf[i] = j;
  85. }
  86. }
  87. data->last_updated[slice] = jiffies;
  88. data->valid |= (1 << slice);
  89. }
  90. exit_up:
  91. mutex_unlock(&data->update_lock);
  92. }
  93. static ssize_t max6875_read(struct file *filp, struct kobject *kobj,
  94. struct bin_attribute *bin_attr,
  95. char *buf, loff_t off, size_t count)
  96. {
  97. struct i2c_client *client = kobj_to_i2c_client(kobj);
  98. struct max6875_data *data = i2c_get_clientdata(client);
  99. int slice, max_slice;
  100. if (off > USER_EEPROM_SIZE)
  101. return 0;
  102. if (off + count > USER_EEPROM_SIZE)
  103. count = USER_EEPROM_SIZE - off;
  104. /* refresh slices which contain requested bytes */
  105. max_slice = (off + count - 1) >> SLICE_BITS;
  106. for (slice = (off >> SLICE_BITS); slice <= max_slice; slice++)
  107. max6875_update_slice(client, slice);
  108. memcpy(buf, &data->data[off], count);
  109. return count;
  110. }
  111. static struct bin_attribute user_eeprom_attr = {
  112. .attr = {
  113. .name = "eeprom",
  114. .mode = S_IRUGO,
  115. },
  116. .size = USER_EEPROM_SIZE,
  117. .read = max6875_read,
  118. };
  119. static int max6875_probe(struct i2c_client *client,
  120. const struct i2c_device_id *id)
  121. {
  122. struct i2c_adapter *adapter = client->adapter;
  123. struct max6875_data *data;
  124. int err;
  125. if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WRITE_BYTE_DATA
  126. | I2C_FUNC_SMBUS_READ_BYTE))
  127. return -ENODEV;
  128. /* Only bind to even addresses */
  129. if (client->addr & 1)
  130. return -ENODEV;
  131. if (!(data = kzalloc(sizeof(struct max6875_data), GFP_KERNEL)))
  132. return -ENOMEM;
  133. /* A fake client is created on the odd address */
  134. data->fake_client = i2c_new_dummy(client->adapter, client->addr + 1);
  135. if (!data->fake_client) {
  136. err = -ENOMEM;
  137. goto exit_kfree;
  138. }
  139. /* Init real i2c_client */
  140. i2c_set_clientdata(client, data);
  141. mutex_init(&data->update_lock);
  142. err = sysfs_create_bin_file(&client->dev.kobj, &user_eeprom_attr);
  143. if (err)
  144. goto exit_remove_fake;
  145. return 0;
  146. exit_remove_fake:
  147. i2c_unregister_device(data->fake_client);
  148. exit_kfree:
  149. kfree(data);
  150. return err;
  151. }
  152. static int max6875_remove(struct i2c_client *client)
  153. {
  154. struct max6875_data *data = i2c_get_clientdata(client);
  155. i2c_unregister_device(data->fake_client);
  156. sysfs_remove_bin_file(&client->dev.kobj, &user_eeprom_attr);
  157. kfree(data);
  158. return 0;
  159. }
  160. static const struct i2c_device_id max6875_id[] = {
  161. { "max6875", 0 },
  162. { }
  163. };
  164. static struct i2c_driver max6875_driver = {
  165. .driver = {
  166. .name = "max6875",
  167. },
  168. .probe = max6875_probe,
  169. .remove = max6875_remove,
  170. .id_table = max6875_id,
  171. };
  172. module_i2c_driver(max6875_driver);
  173. MODULE_AUTHOR("Ben Gardner <bgardner@wabtec.com>");
  174. MODULE_DESCRIPTION("MAX6875 driver");
  175. MODULE_LICENSE("GPL");