blob: 7952b6ecaa2df79ef256b8d48662c9b717069f84 [file] [log] [blame]
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +02001Kernel driver max6650
2=====================
3
4Supported chips:
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -03005
Jean Delvare9c084da2011-05-25 20:43:32 +02006 * Maxim MAX6650
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -03007
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +02008 Prefix: 'max6650'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -03009
Jean Delvare67b670f2011-05-25 20:43:32 +020010 Addresses scanned: none
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030011
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +020012 Datasheet: http://pdfserv.maxim-ic.com/en/ds/MAX6650-MAX6651.pdf
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030013
Jean Delvare9c084da2011-05-25 20:43:32 +020014 * Maxim MAX6651
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030015
Jean Delvare9c084da2011-05-25 20:43:32 +020016 Prefix: 'max6651'
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030017
Jean Delvare9c084da2011-05-25 20:43:32 +020018 Addresses scanned: none
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030019
Jean Delvare9c084da2011-05-25 20:43:32 +020020 Datasheet: http://pdfserv.maxim-ic.com/en/ds/MAX6650-MAX6651.pdf
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +020021
22Authors:
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030023 - Hans J. Koch <hjk@hansjkoch.de>
24 - John Morris <john.morris@spirentcom.com>
25 - Claus Gindhart <claus.gindhart@kontron.com>
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +020026
27Description
28-----------
29
Jean Delvare9c084da2011-05-25 20:43:32 +020030This driver implements support for the Maxim MAX6650 and MAX6651.
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +020031
Jean Delvare9c084da2011-05-25 20:43:32 +020032The 2 devices are very similar, but the MAX6550 has a reduced feature
33set, e.g. only one fan-input, instead of 4 for the MAX6651.
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +020034
35The driver is not able to distinguish between the 2 devices.
36
37The driver provides the following sensor accesses in sysfs:
38
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030039=============== ======= =======================================================
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +020040fan1_input ro fan tachometer speed in RPM
41fan2_input ro "
42fan3_input ro "
43fan4_input ro "
44fan1_target rw desired fan speed in RPM (closed loop mode only)
45pwm1_enable rw regulator mode, 0=full on, 1=open loop, 2=closed loop
Mike Looijmans20005cc2016-08-24 10:13:26 +020046 3=off
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +020047pwm1 rw relative speed (0-255), 255=max. speed.
48 Used in open loop mode only.
49fan1_div rw sets the speed range the inputs can handle. Legal
50 values are 1, 2, 4, and 8. Use lower values for
51 faster fans.
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030052=============== ======= =======================================================
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +020053
Jean Delvare67b670f2011-05-25 20:43:32 +020054Usage notes
55-----------
56
57This driver does not auto-detect devices. You will have to instantiate the
Mauro Carvalho Chehabccf988b2019-07-26 09:51:16 -030058devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
Jean Delvare67b670f2011-05-25 20:43:32 +020059details.
60
Hans-Juergen Kochd20620d2007-05-08 17:22:00 +020061Module parameters
62-----------------
63
64If your board has a BIOS that initializes the MAX6650/6651 correctly, you can
65simply load your module without parameters. It won't touch the configuration
66registers then. If your board BIOS doesn't initialize the chip, or you want
67different settings, you can set the following parameters:
68
69voltage_12V: 5=5V fan, 12=12V fan, 0=don't change
70prescaler: Possible values are 1,2,4,8,16, or 0 for don't change
71clock: The clock frequency in Hz of the chip the driver should assume [254000]
72
73Please have a look at the MAX6650/6651 data sheet and make sure that you fully
74understand the meaning of these parameters before you attempt to change them.