Changeset 389

Show
Ignore:
Timestamp:
04/14/99 22:05:16 (16 years ago)
Author:
frodo
Message:

New program doc-insmod.pl to automatically document the insmod

parameters of a module.

Location:
lm-sensors/trunk
Files:
1 added
3 modified

Legend:

Unmodified
Added
Removed
  • lm-sensors/trunk/doc/chips/lm75

    r210 r389  
    11Kernel driver `lm75.o' 
     2===================== 
    23 
    3 Prefixes: lm75 (LM75, I2C) 
     4Status: Complete and well-tested 
    45 
    5 This driver implements support for the National Semiconductor LM75, a 
    6 `Digital Temperature Sensor and Thermal Watchdog with Two-Wire Interface'. 
     6Supported chips:  
     7  * National Semiconductors LM75 
     8    Prefix: `lm75' 
     9    Addresses scanned: I2C 0x48 - 0x4f (inclusive) 
     10    Datasheet: Publicly available at the National Semiconductors website 
     11 
     12 
     13Description 
     14----------- 
    715 
    816The LM75 implements one temperature sensor. Limits can be set through the 
     
    1220gets higher then the Overtemperature Shutdown value; it stays on until 
    1321the temperature falls below the Hysteris value. 
    14 All temperatures are in degrees Celcius. 
     22All temperatures are in degrees Celcius, and are guaranteed within a  
     23range of -55 to +125 degrees. 
    1524 
    1625The LM75 only updates its values each 1.5 seconds; reading it more often 
    1726will do no harm, but will return 'old' values. 
    1827 
     28The LM75 is usually used in combination with LM78-like chips, to measure 
     29the temperature of the processor(s). 
    1930 
    20 /proc and sysctl interface files: 
    21   * temp (LM75_SYSCTL_TEMP) 
    22     Overtemperature Shutdown Value (RW,1), Hysteris Value (RW,1) and Current  
    23     Temperature (R,1). 
    2431 
    25 configuration file features: 
    26                NAME        LABEL CLASS     COMPUTE CLASS   RW 
    27                temp:                                       R  
    28           temp_hyst:              temp              temp   RW 
    29           temp_over:              temp              temp   RW 
     32Configuration file features 
     33--------------------------- 
     34 
     35          LABEL     LABEL CLASS   COMPUTE CLASS ACCESS MAGNITUDE 
     36           temp            NONE            NONE      R     1 
     37      temp_hyst            temp            temp      RW    1 
     38      temp_over            temp            temp      RW    1 
     39 
     40 
     41          LABEL                           FEATURE SYMBOL     SYSCTL FILE:OFFSET 
     42           temp                        SENSORS_LM75_TEMP            temp:3 
     43      temp_hyst                   SENSORS_LM75_TEMP_HYST            temp:2 
     44      temp_over                   SENSORS_LM75_TEMP_OVER            temp:1 
     45 
  • lm-sensors/trunk/prog/detect/sensors-detect

    r375 r389  
    22 
    33# 
    4 #    detect.pl - Detect PCI bus and chips 
     4#    sensors-detect - Detect PCI bus and chips 
    55#    Copyright (c) 1998, 1999  Frodo Looijaard <frodol@dds.nl> 
    66# 
  • lm-sensors/trunk/prog/doc/doc-features.pl

    r385 r389  
    11#!/usr/bin/perl 
     2 
     3# 
     4#    doc-features.pl - Generate module/library documentation 
     5#    Copyright (c) 1999  Frodo Looijaard <frodol@dds.nl> 
     6# 
     7#    This program is free software; you can redistribute it and/or modify 
     8#    it under the terms of the GNU General Public License as published by 
     9#    the Free Software Foundation; either version 2 of the License, or 
     10#    (at your option) any later version. 
     11# 
     12#    This program is distributed in the hope that it will be useful, 
     13#    but WITHOUT ANY WARRANTY; without even the implied warranty of 
     14#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
     15#    GNU General Public License for more details. 
     16# 
     17#    You should have received a copy of the GNU General Public License 
     18#    along with this program; if not, write to the Free Software 
     19#    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 
     20# 
    221 
    322use strict; 
     
    197216sub scan_all 
    198217{ 
    199   my ($prefix) = @_; 
     218  my ($prefix,@modules) = @_; 
    200219  my ($filename); 
    201220  scan_chips_h $prefix . "/lib/chips.h"; 
    202221  scan_chips_c_1 $prefix . "/lib/chips.c"; 
    203222  scan_chips_c_2 $prefix . "/lib/chips.c"; 
    204   foreach $filename (glob ($prefix ."/kernel/chips/*.c")) {  
    205     scan_kernel_module $filename  
     223  foreach $filename (@modules) {  
     224    scan_kernel_module "$prefix/kernel/chips/$filename" 
    206225  } 
    207226} 
     
    245264} 
    246265 
     266sub help_message 
     267{ 
     268  print STDERR "Syntax: doc-features PATH MODULES...\n"; 
     269  print STDERR "PATH is the path to the base of the lm_sensors tree.\n"; 
     270  print STDERR "MODULES are the modules that need to be examined. If none ". 
     271               "are specified,\n". 
     272               "all modules are examined. Modules are looked for in ". 
     273               "PATH/kernel/chips\n."; 
     274} 
     275 
     276# @_: @ARGV 
     277# Returns ($base_dir,@modules) 
     278sub scan_arguments  
     279{ 
     280  my ($base_dir,@modules); 
     281  if (@_ < 1 or @_[0] =~ /^-/) { 
     282    help_message; 
     283    exit 0; 
     284  } 
     285  $base_dir = @_[0]; 
     286  if (@_ == 1) { 
     287    @modules = map { substr $_, length "$base_dir/kernel/chips/" } 
     288                   glob "$base_dir/kernel/chips/*.c"; 
     289  } else { 
     290    splice(@_,0,1); 
     291    @modules = map { $_ !~ /\./ ? $_.".c" : $_ } @_;  
     292  } 
     293  return ($base_dir,@modules) 
     294} 
    247295 
    248296initialize; 
    249 scan_all "../.."; 
     297scan_all scan_arguments @ARGV; 
    250298my $el; 
    251299foreach $el (keys %features) { 
    252   output_data $el; 
    253   print "\n\n"; 
    254 } 
     300  if (exists $sysctls{$features{$el}->{features}->[0]->{sysctl}}) { 
     301    output_data $el; 
     302    print "\n\n"; 
     303  } 
     304}