max197.rst 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. Kernel driver max197
  2. ====================
  3. Author:
  4. * Vivien Didelot <vivien.didelot@savoirfairelinux.com>
  5. Supported chips:
  6. * Maxim MAX197
  7. Prefix: 'max197'
  8. Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX197.pdf
  9. * Maxim MAX199
  10. Prefix: 'max199'
  11. Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX199.pdf
  12. Description
  13. -----------
  14. The A/D converters MAX197, and MAX199 are both 8-Channel, Multi-Range, 5V,
  15. 12-Bit DAS with 8+4 Bus Interface and Fault Protection.
  16. The available ranges for the MAX197 are {0,-5V} to 5V, and {0,-10V} to 10V,
  17. while they are {0,-2V} to 2V, and {0,-4V} to 4V on the MAX199.
  18. Platform data
  19. -------------
  20. The MAX197 platform data (defined in linux/platform_data/max197.h) should be
  21. filled with a pointer to a conversion function, defined like::
  22. int convert(u8 ctrl);
  23. ctrl is the control byte to write to start a new conversion.
  24. On success, the function must return the 12-bit raw value read from the chip,
  25. or a negative error code otherwise.
  26. Control byte format:
  27. ======= ========== ============================================
  28. Bit Name Description
  29. 7,6 PD1,PD0 Clock and Power-Down modes
  30. 5 ACQMOD Internal or External Controlled Acquisition
  31. 4 RNG Full-scale voltage magnitude at the input
  32. 3 BIP Unipolar or Bipolar conversion mode
  33. 2,1,0 A2,A1,A0 Channel
  34. ======= ========== ============================================
  35. Sysfs interface
  36. ---------------
  37. ============== ==============================================================
  38. in[0-7]_input The conversion value for the corresponding channel.
  39. RO
  40. in[0-7]_min The lower limit (in mV) for the corresponding channel.
  41. For the MAX197, it will be adjusted to -10000, -5000, or 0.
  42. For the MAX199, it will be adjusted to -4000, -2000, or 0.
  43. RW
  44. in[0-7]_max The higher limit (in mV) for the corresponding channel.
  45. For the MAX197, it will be adjusted to 0, 5000, or 10000.
  46. For the MAX199, it will be adjusted to 0, 2000, or 4000.
  47. RW
  48. ============== ==============================================================