Changeset 4208

Timestamp:

10/13/06 21:55:41 (7 years ago)

Author:

khali

Message:

libsensors: Drop support for algorithm names.
I2C algorithms no longer have names in Linux 2.6, and anyway they are
implementation details user-space doesn't care about. No third party
application is known to have ever used this particular feature of
libsensors. "sensord" and "sensors" no longer do.

Location:

lm-sensors/trunk

Files:

• CHANGES (modified) (1 diff)
• lib/access.c (modified) (1 diff)
• lib/conf-parse.y (modified) (2 diffs)
• lib/data.h (modified) (1 diff)
• lib/init.c (modified) (1 diff)
• lib/libsensors.3 (modified) (3 diffs)
• lib/proc.c (modified) (2 diffs)
• lib/sensors.conf.5 (modified) (3 diffs)
• lib/sensors.h (modified) (1 diff)
• lib/sysfs.c (modified) (1 diff)

lm-sensors/trunk/CHANGES

@@ -5 +5 @@
   Library: Add support for the pc87247 driver (fans only)
            Probe for busses before chips
+           Drop support for algorithm names
   Man page sensors.1: Update (option -c) and clean up
   Module icspll: Delete. It was useless and dangerous.

lm-sensors/trunk/lib/access.c

@@ -318 +318 @@
 }
 
+/* This function is deprecated and will be dropped soon. */
 const char *sensors_get_algorithm_name(int bus_nr)
 {
-        int i;
-
-        if (bus_nr == SENSORS_CHIP_NAME_BUS_ISA)
-                return "ISA algorithm";
-        if (bus_nr == SENSORS_CHIP_NAME_BUS_PCI)
-                return "PCI algorithm";
-        if (bus_nr == SENSORS_CHIP_NAME_BUS_DUMMY)
-                return "Dummy algorithm";
-        for (i = 0; i < sensors_proc_bus_count; i++)
-                if (sensors_proc_bus[i].number == bus_nr)
-                        return sensors_proc_bus[i].algorithm;
-        return NULL;
+        return "No longer available";
 }
 

lm-sensors/trunk/lib/conf-parse.y

@@ -135 +135 @@
 
 line:     bus_statement EOL
+        | busalgo_statement EOL
         | label_statement EOL
         | set_statement EOL
@@ -143 +144 @@
 ;
 
-bus_statement:    BUS i2cbus_name adapter_name algorithm_name
+bus_statement:    BUS i2cbus_name adapter_name
                   { sensors_bus new_el;
                     new_el.lineno = $1;
                     new_el.number = $2;
                     new_el.adapter = $3;
-                    new_el.algorithm = $4;
                     bus_add_el(&new_el);
                   }
+;
+
+/* for compatibility, deprecated */
+busalgo_statement:        BUS i2cbus_name adapter_name algorithm_name
+                          { sensors_bus new_el;
+                            new_el.lineno = $1;
+                            new_el.number = $2;
+                            new_el.adapter = $3;
+                            free($4);
+                            bus_add_el(&new_el);
+                          }
 ;
 

lm-sensors/trunk/lib/data.h

@@ -112 +112 @@
 
 /* Config file bus declaration: the i2c bus number, combined with adapter
-   and algorithm names */
+   name */
 typedef struct sensors_bus {
   int number;
   char *adapter;
-  char *algorithm;
   int lineno;
 } sensors_bus;

lm-sensors/trunk/lib/init.c

@@ -104 +104 @@
 {
   free(bus.adapter);
-  free(bus.algorithm);
 }
 

lm-sensors/trunk/lib/libsensors.3

@@ -25 +25 @@
 .\" References consulted:
 .\"     libsensors source code
-.TH libsensors 3  "December 30, 1998" "" "Linux Programmer's Manual"
+.TH libsensors 3  "October 2006" "" "Linux Programmer's Manual"
 .SH NAME
-libsensors \- publically accessible functions provided by the sensors library
+libsensors \- publicly accessible functions provided by the sensors library
 .SH SYNOPSIS
 .nf
@@ -40 +40 @@
 .B int sensors_chip_name_has_wildcards(sensors_chip_name chip);
 .B const char *sensors_get_adapter_name(int bus_nr);
-.B const char *sensors_get_algorithm_name(int bus_nr);
 .B int sensors_get_label(sensors_chip_name name, int feature, 
                       \fBchar **result);\fP
@@ -80 +79 @@
 .B const char *sensors_get_adapter_name(int bus_nr);
 .br
+This function returns the adapter name of a bus number, as used within the
+sensors_chip_name structure. If it could not be found, it returns NULL.
+
 .B const char *sensors_get_algorithm_name(int bus_nr);
 .br
-These functions return the adapter and algorithm names of a bus number, as used within the sensors_chip_name structure. If it could not be found, it returns NULL
+This function used to return the algorithm name of a bus number.
+It is now deprecated and returns an arbitrary string. It will be dropped
+in a later version of the library so you should stop using it.
 
 \fBint sensors_get_label(sensors_chip_name name, int feature,

lm-sensors/trunk/lib/proc.c

@@ -95 +95 @@
     if (! (border = rindex(line,'\t')))
       goto ERROR;
-    if (! (entry.algorithm = strdup(border+1)))
-      goto FAT_ERROR;
+    /* Skip algorithm name */
     *border='\0';
     if (! (border = rindex(line,'\t')))
@@ -110 +109 @@
     if (sensors_parse_i2cbus_name(line,&entry.number))
       goto ERROR;
-    sensors_strip_of_spaces(entry.algorithm);
     sensors_strip_of_spaces(entry.adapter);
     sensors_add_proc_bus(&entry);

lm-sensors/trunk/lib/sensors.conf.5

@@ -24 +24 @@
 .\" References consulted:
 .\"     sensors.conf.eg by Frodo Looijaard
-.TH sensors.conf 5  "February 8, 1999" "" "Linux Programmer's Manual"
+.TH sensors.conf 5  "October 2006" "" "Linux Programmer's Manual"
 .SH NAME
 sensors.conf \- libsensors configuration file
@@ -125 +125 @@
 
 .RS
-bus "i2c\-0" "SMBus PIIX4 adapter at e800" "Non\-I2C SMBus adapter"
+bus "i2c\-0" "SMBus PIIX4 adapter at e800"
 .RE
 
@@ -140 +140 @@
 always be quoted.
 
-The second and third arguments are the 
-description texts. They must be exactly match the texts as they appear in
-.IR /proc/bus/i2c ,
-except for trailing spaces, which are removed both from the /proc
-entries and the arguments. The adapter description comes first, followed
-by the algorithm description.
+The second argument is the adapter name, it must match exactly the
+adapter name as it appears in
+.I /proc/bus/i2c
+(2.4 kernel)
+or
+.I /sys/class/i2c-adapter/i2c-*/device/name
+(2.6 kernel).
+It should always be quoted as well as it will most certainly contain
+spaces or dashes.
+
+There used to be a third argument, the algorithm name. For compatibility
+reasons, the parser still accepts this third argument, but ignores it.
 
 The

lm-sensors/trunk/lib/sensors.h

@@ -69 +69 @@
 extern int sensors_chip_name_has_wildcards(sensors_chip_name chip);
 
-/* These functions return the adapter and algorithm names of a bus number,
+/* This function returns the adapter name of a bus number,
    as used within the sensors_chip_name structure. If it could not be found, 
    it returns NULL */
 extern const char *sensors_get_adapter_name(int bus_nr);
+
+/* This function is deprecated and will be dropped soon. */
 extern const char *sensors_get_algorithm_name(int bus_nr);
 

lm-sensors/trunk/lib/sysfs.c

@@ -208 +208 @@
                 if (!strncmp(entry.adapter, "ISA ", 4)) {
                         entry.number = SENSORS_CHIP_NAME_BUS_ISA;
-                        entry.algorithm = strdup("ISA bus algorithm");
                 } else if (sscanf(clsdev->name, "i2c-%d", &entry.number) != 1) {
                         entry.number = SENSORS_CHIP_NAME_BUS_DUMMY;
-                        entry.algorithm = strdup("Dummy bus algorithm");
-                } else
-                        entry.algorithm = strdup("Unavailable from sysfs");
-
-                if (!entry.algorithm)
-                        sensors_fatal_error(__FUNCTION__, "out of memory");
+                }
 
                 sensors_add_proc_bus(&entry);