Linux 6.7-rc7
[linux-modified.git] / Documentation / ABI / testing / sysfs-class-hwmon
1 What:           /sys/class/hwmon/hwmonX/name
2 Description:
3                 The chip name.
4                 This should be a short, lowercase string, not containing
5                 whitespace, dashes, or the wildcard character '*'.
6                 This attribute represents the chip name. It is the only
7                 mandatory attribute.
8                 I2C devices get this attribute created automatically.
9
10                 RO
11
12 What:           /sys/class/hwmon/hwmonX/label
13 Description:
14                 A descriptive label that allows to uniquely identify a
15                 device within the system.
16                 The contents of the label are free-form.
17
18                 RO
19
20 What:           /sys/class/hwmon/hwmonX/update_interval
21 Description:
22                 The interval at which the chip will update readings.
23                 Unit: millisecond
24
25                 RW
26
27                 Some devices have a variable update rate or interval.
28                 This attribute can be used to change it to the desired value.
29
30 What:           /sys/class/hwmon/hwmonX/inY_min
31 Description:
32                 Voltage min value.
33
34                 Unit: millivolt
35
36                 RW
37
38 What:           /sys/class/hwmon/hwmonX/inY_lcrit
39 Description:
40                 Voltage critical min value.
41
42                 Unit: millivolt
43
44                 RW
45
46                 If voltage drops to or below this limit, the system may
47                 take drastic action such as power down or reset. At the very
48                 least, it should report a fault.
49
50 What:           /sys/class/hwmon/hwmonX/inY_max
51 Description:
52                 Voltage max value.
53
54                 Unit: millivolt
55
56                 RW
57
58 What:           /sys/class/hwmon/hwmonX/inY_crit
59 Description:
60                 Voltage critical max value.
61
62                 Unit: millivolt
63
64                 RW
65
66                 If voltage reaches or exceeds this limit, the system may
67                 take drastic action such as power down or reset. At the very
68                 least, it should report a fault.
69
70 What:           /sys/class/hwmon/hwmonX/inY_input
71 Description:
72                 Voltage input value.
73
74                 Unit: millivolt
75
76                 RO
77
78                 Voltage measured on the chip pin.
79
80                 Actual voltage depends on the scaling resistors on the
81                 motherboard, as recommended in the chip datasheet.
82
83                 This varies by chip and by motherboard.
84                 Because of this variation, values are generally NOT scaled
85                 by the chip driver, and must be done by the application.
86                 However, some drivers (notably lm87 and via686a)
87                 do scale, because of internal resistors built into a chip.
88                 These drivers will output the actual voltage. Rule of
89                 thumb: drivers should report the voltage values at the
90                 "pins" of the chip.
91
92 What:           /sys/class/hwmon/hwmonX/inY_average
93 Description:
94                 Average voltage
95
96                 Unit: millivolt
97
98                 RO
99
100 What:           /sys/class/hwmon/hwmonX/inY_lowest
101 Description:
102                 Historical minimum voltage
103
104                 Unit: millivolt
105
106                 RO
107
108 What:           /sys/class/hwmon/hwmonX/inY_highest
109 Description:
110                 Historical maximum voltage
111
112                 Unit: millivolt
113
114                 RO
115
116 What:           /sys/class/hwmon/hwmonX/inY_reset_history
117 Description:
118                 Reset inX_lowest and inX_highest
119
120                 WO
121
122 What:           /sys/class/hwmon/hwmonX/in_reset_history
123 Description:
124                 Reset inX_lowest and inX_highest for all sensors
125
126                 WO
127
128 What:           /sys/class/hwmon/hwmonX/inY_label
129 Description:
130                 Suggested voltage channel label.
131
132                 Text string
133
134                 Should only be created if the driver has hints about what
135                 this voltage channel is being used for, and user-space
136                 doesn't. In all other cases, the label is provided by
137                 user-space.
138
139                 RO
140
141 What:           /sys/class/hwmon/hwmonX/inY_enable
142 Description:
143                 Enable or disable the sensors.
144
145                 When disabled the sensor read will return -ENODATA.
146
147                 - 1: Enable
148                 - 0: Disable
149
150                 RW
151
152 What:           /sys/class/hwmon/hwmonX/cpuY_vid
153 Description:
154                 CPU core reference voltage.
155
156                 Unit: millivolt
157
158                 RO
159
160                 Not always correct.
161
162 What:           /sys/class/hwmon/hwmonX/vrm
163 Description:
164                 Voltage Regulator Module version number.
165
166                 RW (but changing it should no more be necessary)
167
168                 Originally the VRM standard version multiplied by 10, but now
169                 an arbitrary number, as not all standards have a version
170                 number.
171
172                 Affects the way the driver calculates the CPU core reference
173                 voltage from the vid pins.
174
175 What:           /sys/class/hwmon/hwmonX/inY_rated_min
176 Description:
177                 Minimum rated voltage.
178
179                 Unit: millivolt
180
181                 RO
182
183 What:           /sys/class/hwmon/hwmonX/inY_rated_max
184 Description:
185                 Maximum rated voltage.
186
187                 Unit: millivolt
188
189                 RO
190
191 What:           /sys/class/hwmon/hwmonX/fanY_min
192 Description:
193                 Fan minimum value
194
195                 Unit: revolution/min (RPM)
196
197                 RW
198
199 What:           /sys/class/hwmon/hwmonX/fanY_max
200 Description:
201                 Fan maximum value
202
203                 Unit: revolution/min (RPM)
204
205                 Only rarely supported by the hardware.
206                 RW
207
208 What:           /sys/class/hwmon/hwmonX/fanY_input
209 Description:
210                 Fan input value.
211
212                 Unit: revolution/min (RPM)
213
214                 RO
215
216 What:           /sys/class/hwmon/hwmonX/fanY_div
217 Description:
218                 Fan divisor.
219
220                 Integer value in powers of two (1, 2, 4, 8, 16, 32, 64, 128).
221
222                 RW
223
224                 Some chips only support values 1, 2, 4 and 8.
225                 Note that this is actually an internal clock divisor, which
226                 affects the measurable speed range, not the read value.
227
228 What:           /sys/class/hwmon/hwmonX/fanY_pulses
229 Description:
230                 Number of tachometer pulses per fan revolution.
231
232                 Integer value, typically between 1 and 4.
233
234                 RW
235
236                 This value is a characteristic of the fan connected to the
237                 device's input, so it has to be set in accordance with the fan
238                 model.
239
240                 Should only be created if the chip has a register to configure
241                 the number of pulses. In the absence of such a register (and
242                 thus attribute) the value assumed by all devices is 2 pulses
243                 per fan revolution.
244
245 What:           /sys/class/hwmon/hwmonX/fanY_target
246 Description:
247                 Desired fan speed
248
249                 Unit: revolution/min (RPM)
250
251                 RW
252
253                 Only makes sense if the chip supports closed-loop fan speed
254                 control based on the measured fan speed.
255
256 What:           /sys/class/hwmon/hwmonX/fanY_label
257 Description:
258                 Suggested fan channel label.
259
260                 Text string
261
262                 Should only be created if the driver has hints about what
263                 this fan channel is being used for, and user-space doesn't.
264                 In all other cases, the label is provided by user-space.
265
266                 RO
267
268 What:           /sys/class/hwmon/hwmonX/fanY_enable
269 Description:
270                 Enable or disable the sensors.
271
272                 When disabled the sensor read will return -ENODATA.
273
274                 - 1: Enable
275                 - 0: Disable
276
277                 RW
278
279 What:           /sys/class/hwmon/hwmonX/fanY_fault
280 Description:
281                 Reports if a fan has reported failure.
282
283                 - 1: Failed
284                 - 0: Ok
285
286                 RO
287
288 What:           /sys/class/hwmon/hwmonX/pwmY
289 Description:
290                 Pulse width modulation fan control.
291
292                 Integer value in the range 0 to 255
293
294                 RW
295
296                 255 is max or 100%.
297
298 What:           /sys/class/hwmon/hwmonX/pwmY_enable
299 Description:
300                 Fan speed control method:
301
302                 - 0: no fan speed control (i.e. fan at full speed)
303                 - 1: manual fan speed control enabled (using `pwmY`)
304                 - 2+: automatic fan speed control enabled
305
306                 Check individual chip documentation files for automatic mode
307                 details.
308
309                 RW
310
311 What:           /sys/class/hwmon/hwmonX/pwmY_mode
312 Description:
313                 - 0: DC mode (direct current)
314                 - 1: PWM mode (pulse-width modulation)
315
316                 RW
317
318 What:           /sys/class/hwmon/hwmonX/pwmY_freq
319 Description:
320                 Base PWM frequency in Hz.
321
322                 Only possibly available when pwmN_mode is PWM, but not always
323                 present even then.
324
325                 RW
326
327 What:           /sys/class/hwmon/hwmonX/pwmY_auto_channels_temp
328 Description:
329                 Select which temperature channels affect this PWM output in
330                 auto mode.
331
332                 Bitfield, 1 is temp1, 2 is temp2, 4 is temp3 etc...
333                 Which values are possible depend on the chip used.
334
335                 RW
336
337 What:           /sys/class/hwmon/hwmonX/pwmY_auto_pointZ_pwm
338 What:           /sys/class/hwmon/hwmonX/pwmY_auto_pointZ_temp
339 What:           /sys/class/hwmon/hwmonX/pwmY_auto_pointZ_temp_hyst
340 Description:
341                 Define the PWM vs temperature curve.
342
343                 Number of trip points is chip-dependent. Use this for chips
344                 which associate trip points to PWM output channels.
345
346                 RW
347
348 What:           /sys/class/hwmon/hwmonX/tempY_auto_pointZ_pwm
349 What:           /sys/class/hwmon/hwmonX/tempY_auto_pointZ_temp
350 What:           /sys/class/hwmon/hwmonX/tempY_auto_pointZ_temp_hyst
351 Description:
352                 Define the PWM vs temperature curve.
353
354                 Number of trip points is chip-dependent. Use this for chips
355                 which associate trip points to temperature channels.
356
357                 RW
358
359 What:           /sys/class/hwmon/hwmonX/tempY_type
360 Description:
361                 Sensor type selection.
362
363                 Integers 1 to 6
364
365                 RW
366
367                 - 1: CPU embedded diode
368                 - 2: 3904 transistor
369                 - 3: thermal diode
370                 - 4: thermistor
371                 - 5: AMD AMDSI
372                 - 6: Intel PECI
373
374                 Not all types are supported by all chips
375
376 What:           /sys/class/hwmon/hwmonX/tempY_max
377 Description:
378                 Temperature max value.
379
380                 Unit: millidegree Celsius (or millivolt, see below)
381
382                 RW
383
384 What:           /sys/class/hwmon/hwmonX/tempY_min
385 Description:
386                 Temperature min value.
387
388                 Unit: millidegree Celsius
389
390                 RW
391
392 What:           /sys/class/hwmon/hwmonX/tempY_max_hyst
393 Description:
394                 Temperature hysteresis value for max limit.
395
396                 Unit: millidegree Celsius
397
398                 Must be reported as an absolute temperature, NOT a delta
399                 from the max value.
400
401                 RW
402
403 What:           /sys/class/hwmon/hwmonX/tempY_min_hyst
404 Description:
405                 Temperature hysteresis value for min limit.
406                 Unit: millidegree Celsius
407
408                 Must be reported as an absolute temperature, NOT a delta
409                 from the min value.
410
411                 RW
412
413 What:           /sys/class/hwmon/hwmonX/tempY_input
414 Description:
415                 Temperature input value.
416
417                 Unit: millidegree Celsius
418
419                 RO
420
421 What:           /sys/class/hwmon/hwmonX/tempY_crit
422 Description:
423                 Temperature critical max value, typically greater than
424                 corresponding temp_max values.
425
426                 Unit: millidegree Celsius
427
428                 RW
429
430 What:           /sys/class/hwmon/hwmonX/tempY_crit_alarm
431 Description:
432                 Critical high temperature alarm flag.
433
434                 - 0: OK
435                 - 1: temperature has reached tempY_crit
436
437                 RW
438
439                 Contrary to regular alarm flags which clear themselves
440                 automatically when read, this one sticks until cleared by
441                 the user. This is done by writing 0 to the file. Writing
442                 other values is unsupported.
443
444 What:           /sys/class/hwmon/hwmonX/tempY_crit_hyst
445 Description:
446                 Temperature hysteresis value for critical limit.
447
448                 Unit: millidegree Celsius
449
450                 Must be reported as an absolute temperature, NOT a delta
451                 from the critical value.
452
453                 RW
454
455 What:           /sys/class/hwmon/hwmonX/tempY_emergency
456 Description:
457                 Temperature emergency max value, for chips supporting more than
458                 two upper temperature limits. Must be equal or greater than
459                 corresponding temp_crit values.
460
461                 Unit: millidegree Celsius
462
463                 RW
464
465 What:           /sys/class/hwmon/hwmonX/tempY_emergency_hyst
466 Description:
467                 Temperature hysteresis value for emergency limit.
468
469                 Unit: millidegree Celsius
470
471                 Must be reported as an absolute temperature, NOT a delta
472                 from the emergency value.
473
474                 RW
475
476 What:           /sys/class/hwmon/hwmonX/tempY_lcrit
477 Description:
478                 Temperature critical min value, typically lower than
479                 corresponding temp_min values.
480
481                 Unit: millidegree Celsius
482
483                 RW
484
485 What:           /sys/class/hwmon/hwmonX/tempY_lcrit_hyst
486 Description:
487                 Temperature hysteresis value for critical min limit.
488
489                 Unit: millidegree Celsius
490
491                 Must be reported as an absolute temperature, NOT a delta
492                 from the critical min value.
493
494                 RW
495
496 What:           /sys/class/hwmon/hwmonX/tempY_offset
497 Description:
498                 Temperature offset which is added to the temperature reading
499                 by the chip.
500
501                 Unit: millidegree Celsius
502
503                 Read/Write value.
504
505 What:           /sys/class/hwmon/hwmonX/tempY_label
506 Description:
507                 Suggested temperature channel label.
508
509                 Text string
510
511                 Should only be created if the driver has hints about what
512                 this temperature channel is being used for, and user-space
513                 doesn't. In all other cases, the label is provided by
514                 user-space.
515
516                 RO
517
518 What:           /sys/class/hwmon/hwmonX/tempY_lowest
519 Description:
520                 Historical minimum temperature
521
522                 Unit: millidegree Celsius
523
524                 RO
525
526 What:           /sys/class/hwmon/hwmonX/tempY_highest
527 Description:
528                 Historical maximum temperature
529
530                 Unit: millidegree Celsius
531
532                 RO
533
534 What:           /sys/class/hwmon/hwmonX/tempY_reset_history
535 Description:
536                 Reset temp_lowest and temp_highest
537
538                 WO
539
540 What:           /sys/class/hwmon/hwmonX/temp_reset_history
541 Description:
542                 Reset temp_lowest and temp_highest for all sensors
543
544                 WO
545
546 What:           /sys/class/hwmon/hwmonX/tempY_enable
547 Description:
548                 Enable or disable the sensors.
549
550                 When disabled the sensor read will return -ENODATA.
551
552                 - 1: Enable
553                 - 0: Disable
554
555                 RW
556
557 What:           /sys/class/hwmon/hwmonX/tempY_rated_min
558 Description:
559                 Minimum rated temperature.
560
561                 Unit: millidegree Celsius
562
563                 RO
564
565 What:           /sys/class/hwmon/hwmonX/tempY_rated_max
566 Description:
567                 Maximum rated temperature.
568
569                 Unit: millidegree Celsius
570
571                 RO
572
573 What:           /sys/class/hwmon/hwmonX/currY_max
574 Description:
575                 Current max value
576
577                 Unit: milliampere
578
579                 RW
580
581 What:           /sys/class/hwmon/hwmonX/currY_min
582 Description:
583                 Current min value.
584
585                 Unit: milliampere
586
587                 RW
588
589 What:           /sys/class/hwmon/hwmonX/currY_lcrit
590 Description:
591                 Current critical low value
592
593                 Unit: milliampere
594
595                 RW
596
597 What:           /sys/class/hwmon/hwmonX/currY_crit
598 Description:
599                 Current critical high value.
600
601                 Unit: milliampere
602
603                 RW
604
605 What:           /sys/class/hwmon/hwmonX/currY_input
606 Description:
607                 Current input value
608
609                 Unit: milliampere
610
611                 RO
612
613 What:           /sys/class/hwmon/hwmonX/currY_average
614 Description:
615                 Average current use
616
617                 Unit: milliampere
618
619                 RO
620
621 What:           /sys/class/hwmon/hwmonX/currY_lowest
622 Description:
623                 Historical minimum current
624
625                 Unit: milliampere
626
627                 RO
628
629 What:           /sys/class/hwmon/hwmonX/currY_highest
630 Description:
631                 Historical maximum current
632                 Unit: milliampere
633                 RO
634
635 What:           /sys/class/hwmon/hwmonX/currY_reset_history
636 Description:
637                 Reset currX_lowest and currX_highest
638
639                 WO
640
641 What:           /sys/class/hwmon/hwmonX/curr_reset_history
642 Description:
643                 Reset currX_lowest and currX_highest for all sensors
644
645                 WO
646
647 What:           /sys/class/hwmon/hwmonX/currY_enable
648 Description:
649                 Enable or disable the sensors.
650
651                 When disabled the sensor read will return -ENODATA.
652
653                 - 1: Enable
654                 - 0: Disable
655
656                 RW
657
658 What:           /sys/class/hwmon/hwmonX/currY_rated_min
659 Description:
660                 Minimum rated current.
661
662                 Unit: milliampere
663
664                 RO
665
666 What:           /sys/class/hwmon/hwmonX/currY_rated_max
667 Description:
668                 Maximum rated current.
669
670                 Unit: milliampere
671
672                 RO
673
674 What:           /sys/class/hwmon/hwmonX/powerY_average
675 Description:
676                 Average power use
677
678                 Unit: microWatt
679
680                 RO
681
682 What:           /sys/class/hwmon/hwmonX/powerY_average_interval
683 Description:
684                 Power use averaging interval.  A poll
685                 notification is sent to this file if the
686                 hardware changes the averaging interval.
687
688                 Unit: milliseconds
689
690                 RW
691
692 What:           /sys/class/hwmon/hwmonX/powerY_average_interval_max
693 Description:
694                 Maximum power use averaging interval
695
696                 Unit: milliseconds
697
698                 RO
699
700 What:           /sys/class/hwmon/hwmonX/powerY_average_interval_min
701 Description:
702                 Minimum power use averaging interval
703
704                 Unit: milliseconds
705
706                 RO
707
708 What:           /sys/class/hwmon/hwmonX/powerY_average_highest
709 Description:
710                 Historical average maximum power use
711
712                 Unit: microWatt
713
714                 RO
715
716 What:           /sys/class/hwmon/hwmonX/powerY_average_lowest
717 Description:
718                 Historical average minimum power use
719
720                 Unit: microWatt
721
722                 RO
723
724 What:           /sys/class/hwmon/hwmonX/powerY_average_max
725 Description:
726                 A poll notification is sent to
727                 `powerY_average` when power use
728                 rises above this value.
729
730                 Unit: microWatt
731
732                 RW
733
734 What:           /sys/class/hwmon/hwmonX/powerY_average_min
735 Description:
736                 A poll notification is sent to
737                 `powerY_average` when power use
738                 sinks below this value.
739
740                 Unit: microWatt
741
742                 RW
743
744 What:           /sys/class/hwmon/hwmonX/powerY_input
745 Description:
746                 Instantaneous power use
747
748                 Unit: microWatt
749
750                 RO
751
752 What:           /sys/class/hwmon/hwmonX/powerY_input_highest
753 Description:
754                 Historical maximum power use
755
756                 Unit: microWatt
757
758                 RO
759
760 What:           /sys/class/hwmon/hwmonX/powerY_input_lowest
761 Description:
762                 Historical minimum power use
763
764                 Unit: microWatt
765
766                 RO
767
768 What:           /sys/class/hwmon/hwmonX/powerY_reset_history
769 Description:
770                 Reset input_highest, input_lowest,
771                 average_highest and average_lowest.
772
773                 WO
774
775 What:           /sys/class/hwmon/hwmonX/powerY_accuracy
776 Description:
777                 Accuracy of the power meter.
778
779                 Unit: Percent
780
781                 RO
782
783 What:           /sys/class/hwmon/hwmonX/powerY_cap
784 Description:
785                 If power use rises above this limit, the
786                 system should take action to reduce power use.
787                 A poll notification is sent to this file if the
788                 cap is changed by the hardware.  The `*_cap`
789                 files only appear if the cap is known to be
790                 enforced by hardware.
791
792                 Unit: microWatt
793
794                 RW
795
796 What:           /sys/class/hwmon/hwmonX/powerY_cap_hyst
797 Description:
798                 Margin of hysteresis built around capping and
799                 notification.
800
801                 Unit: microWatt
802
803                 RW
804
805 What:           /sys/class/hwmon/hwmonX/powerY_cap_max
806 Description:
807                 Maximum cap that can be set.
808
809                 Unit: microWatt
810
811                 RO
812
813 What:           /sys/class/hwmon/hwmonX/powerY_cap_min
814 Description:
815                 Minimum cap that can be set.
816
817                 Unit: microWatt
818
819                 RO
820
821 What:           /sys/class/hwmon/hwmonX/powerY_max
822 Description:
823                 Maximum power.
824
825                 Unit: microWatt
826
827                 RW
828
829 What:           /sys/class/hwmon/hwmonX/powerY_crit
830 Description:
831                 Critical maximum power.
832
833                 If power rises to or above this limit, the
834                 system is expected take drastic action to reduce
835                 power consumption, such as a system shutdown or
836                 a forced powerdown of some devices.
837
838                 Unit: microWatt
839
840                 RW
841
842 What:           /sys/class/hwmon/hwmonX/powerY_enable
843 Description:
844                 Enable or disable the sensors.
845
846                 When disabled the sensor read will return
847                 -ENODATA.
848
849                 - 1: Enable
850                 - 0: Disable
851
852                 RW
853
854 What:           /sys/class/hwmon/hwmonX/powerY_rated_min
855 Description:
856                 Minimum rated power.
857
858                 Unit: microWatt
859
860                 RO
861
862 What:           /sys/class/hwmon/hwmonX/powerY_rated_max
863 Description:
864                 Maximum rated power.
865
866                 Unit: microWatt
867
868                 RO
869
870 What:           /sys/class/hwmon/hwmonX/energyY_input
871 Description:
872                 Cumulative energy use
873
874                 Unit: microJoule
875
876                 RO
877
878 What:           /sys/class/hwmon/hwmonX/energyY_enable
879 Description:
880                 Enable or disable the sensors.
881
882                 When disabled the sensor read will return
883                 -ENODATA.
884
885                 - 1: Enable
886                 - 0: Disable
887
888                 RW
889
890 What:           /sys/class/hwmon/hwmonX/humidityY_input
891 Description:
892                 Humidity
893
894                 Unit: milli-percent (per cent mille, pcm)
895
896                 RO
897
898
899 What:           /sys/class/hwmon/hwmonX/humidityY_enable
900 Description:
901                 Enable or disable the sensors
902
903                 When disabled the sensor read will return
904                 -ENODATA.
905
906                 - 1: Enable
907                 - 0: Disable
908
909                 RW
910
911 What:           /sys/class/hwmon/hwmonX/humidityY_rated_min
912 Description:
913                 Minimum rated humidity.
914
915                 Unit: milli-percent (per cent mille, pcm)
916
917                 RO
918
919 What:           /sys/class/hwmon/hwmonX/humidityY_rated_max
920 Description:
921                 Maximum rated humidity.
922
923                 Unit: milli-percent (per cent mille, pcm)
924
925                 RO
926
927
928 What:           /sys/class/hwmon/hwmonX/intrusionY_alarm
929 Description:
930                 Chassis intrusion detection
931
932                 - 0: OK
933                 - 1: intrusion detected
934
935                 RW
936
937                 Contrary to regular alarm flags which clear themselves
938                 automatically when read, this one sticks until cleared by
939                 the user. This is done by writing 0 to the file. Writing
940                 other values is unsupported.
941
942 What:           /sys/class/hwmon/hwmonX/intrusionY_beep
943 Description:
944                 Chassis intrusion beep
945
946                 - 0: disable
947                 - 1: enable
948
949                 RW
950
951 What:           /sys/class/hwmon/hwmonX/device/pec
952 Description:
953                 PEC support on I2C devices
954
955                 - 0, off, n: disable
956                 - 1, on, y: enable
957
958                 RW