From: greg@kroah.com (Greg KH)
To: linux-kernel@vger.kernel.org, sensors@stimpy.netroedge.com
Subject: [PATCH] More i2c driver changes for 2.5.66
Date: Thu, 19 May 2005 06:23:52 +0000 [thread overview]
Message-ID: <1049328958830@kroah.com> (raw)
In-Reply-To: <10493289582408@kroah.com>
In-Reply-To: <1048295086481@kroah.com>
ChangeSet 1.977.29.8, 2003/04/02 11:45:21-08:00, greg@kroah.com
i2c: remove proc and sysctl code from i2c-proc as it is no longer used.
drivers/i2c/i2c-proc.c | 546 -----------------------------------------------
include/linux/i2c-proc.h | 40 ---
2 files changed, 586 deletions(-)
diff -Nru a/drivers/i2c/i2c-proc.c b/drivers/i2c/i2c-proc.c
--- a/drivers/i2c/i2c-proc.c Wed Apr 2 16:01:04 2003
+++ b/drivers/i2c/i2c-proc.c Wed Apr 2 16:01:04 2003
@@ -37,539 +37,6 @@
#include <linux/i2c-proc.h>
#include <asm/uaccess.h>
-static int i2c_parse_reals(int *nrels, void *buffer, int bufsize,
- long *results, int magnitude);
-static int i2c_write_reals(int nrels, void *buffer, size_t *bufsize,
- long *results, int magnitude);
-static int i2c_proc_chips(ctl_table * ctl, int write,
- struct file *filp, void *buffer,
- size_t * lenp);
-static int i2c_sysctl_chips(ctl_table * table, int *name, int nlen,
- void *oldval, size_t * oldlenp,
- void *newval, size_t newlen,
- void **context);
-
-#define SENSORS_ENTRY_MAX 20
-static struct ctl_table_header *i2c_entries[SENSORS_ENTRY_MAX];
-
-static struct i2c_client *i2c_clients[SENSORS_ENTRY_MAX];
-
-static ctl_table i2c_proc_dev_sensors[] = {
- {SENSORS_CHIPS, "chips", NULL, 0, 0644, NULL, &i2c_proc_chips,
- &i2c_sysctl_chips},
- {0}
-};
-
-static ctl_table i2c_proc_dev[] = {
- {DEV_SENSORS, "sensors", NULL, 0, 0555, i2c_proc_dev_sensors},
- {0},
-};
-
-
-static ctl_table i2c_proc[] = {
- {CTL_DEV, "dev", NULL, 0, 0555, i2c_proc_dev},
- {0}
-};
-
-
-static struct ctl_table_header *i2c_proc_header;
-
-/* This returns a nice name for a new directory; for example lm78-isa-0310
- (for a LM78 chip on the ISA bus at port 0x310), or lm75-i2c-3-4e (for
- a LM75 chip on the third i2c bus at address 0x4e).
- name is allocated first. */
-static char *generate_name(struct i2c_client *client, const char *prefix)
-{
- struct i2c_adapter *adapter = client->adapter;
- int addr = client->addr;
- char name_buffer[50], *name;
-
- if (i2c_is_isa_adapter(adapter)) {
- sprintf(name_buffer, "%s-isa-%04x", prefix, addr);
- } else if (adapter->algo->smbus_xfer || adapter->algo->master_xfer) {
- int id = i2c_adapter_id(adapter);
- if (id < 0)
- return ERR_PTR(-ENOENT);
- sprintf(name_buffer, "%s-i2c-%d-%02x", prefix, id, addr);
- } else { /* dummy adapter, generate prefix */
- int end, i;
-
- sprintf(name_buffer, "%s-", prefix);
- end = strlen(name_buffer);
-
- for (i = 0; i < 32; i++) {
- if (adapter->algo->name[i] = ' ')
- break;
- name_buffer[end++] = tolower(adapter->algo->name[i]);
- }
-
- name_buffer[end] = 0;
- sprintf(name_buffer + end, "-%04x", addr);
- }
-
- name = kmalloc(strlen(name_buffer) + 1, GFP_KERNEL);
- if (unlikely(!name))
- return ERR_PTR(-ENOMEM);
- strcpy(name, name_buffer);
- return name;
-}
-
-/* This rather complex function must be called when you want to add an entry
- to /proc/sys/dev/sensors/chips. It also creates a new directory within
- /proc/sys/dev/sensors/.
- ctl_template should be a template of the newly created directory. It is
- copied in memory. The extra2 field of each file is set to point to client.
- If any driver wants subdirectories within the newly created directory,
- this function must be updated! */
-int i2c_register_entry(struct i2c_client *client, const char *prefix,
- struct ctl_table *leaf)
-{
- struct { struct ctl_table root[2], dev[2], sensors[2]; } *tbl;
- struct ctl_table_header *hdr;
- struct ctl_table *tmp;
- const char *name;
- int id;
-
- name = generate_name(client, prefix);
- if (IS_ERR(name))
- return PTR_ERR(name);
-
- for (id = 0; id < SENSORS_ENTRY_MAX; id++) {
- if (!i2c_entries[id])
- goto free_slot;
- }
-
- goto out_free_name;
-
- free_slot:
- tbl = kmalloc(sizeof(*tbl), GFP_KERNEL);
- if (unlikely(!tbl))
- goto out_free_name;
- memset(tbl, 0, sizeof(*tbl));
-
- for (tmp = leaf; tmp->ctl_name; tmp++)
- tmp->extra2 = client;
-
- tbl->sensors->ctl_name = id+256;
- tbl->sensors->procname = name;
- tbl->sensors->mode = 0555;
- tbl->sensors->child = leaf;
-
- tbl->dev->ctl_name = DEV_SENSORS;
- tbl->dev->procname = "sensors";
- tbl->dev->mode = 0555;
- tbl->dev->child = tbl->sensors;
-
- tbl->root->ctl_name = CTL_DEV;
- tbl->root->procname = "dev";
- tbl->root->mode = 0555;
- tbl->root->child = tbl->dev;
-
- hdr = register_sysctl_table(tbl->root, 0);
- if (unlikely(!hdr))
- goto out_free_tbl;
-
- i2c_entries[id] = hdr;
- i2c_clients[id] = client;
-
- return (id + 256); /* XXX(hch) why?? */
-
- out_free_tbl:
- kfree(tbl);
- out_free_name:
- kfree(name);
- return -ENOMEM;
-}
-
-void i2c_deregister_entry(int id)
-{
- id -= 256;
-
- if (i2c_entries[id]) {
- struct ctl_table_header *hdr = i2c_entries[id];
- struct ctl_table *tbl = hdr->ctl_table;
-
- unregister_sysctl_table(hdr);
- kfree(tbl->child->child->procname);
- kfree(tbl); /* actually the whole anonymous struct */
- }
-
- i2c_entries[id] = NULL;
- i2c_clients[id] = NULL;
-}
-
-static int i2c_proc_chips(ctl_table * ctl, int write, struct file *filp,
- void *buffer, size_t * lenp)
-{
- char BUF[SENSORS_PREFIX_MAX + 30];
- int buflen, curbufsize, i;
- struct ctl_table *client_tbl;
-
- if (write)
- return 0;
-
- /* If buffer is size 0, or we try to read when not at the start, we
- return nothing. Note that I think writing when not at the start
- does not work either, but anyway, this is straight from the kernel
- sources. */
- if (!*lenp || (filp->f_pos && !write)) {
- *lenp = 0;
- return 0;
- }
- curbufsize = 0;
- for (i = 0; i < SENSORS_ENTRY_MAX; i++)
- if (i2c_entries[i]) {
- client_tbl - i2c_entries[i]->ctl_table->child->child;
- buflen - sprintf(BUF, "%d\t%s\n", client_tbl->ctl_name,
- client_tbl->procname);
- if (buflen + curbufsize > *lenp)
- buflen = *lenp - curbufsize;
- if(copy_to_user(buffer, BUF, buflen))
- return -EFAULT;
- curbufsize += buflen;
- (char *) buffer += buflen;
- }
- *lenp = curbufsize;
- filp->f_pos += curbufsize;
- return 0;
-}
-
-static int i2c_sysctl_chips(ctl_table * table, int *name, int nlen,
- void *oldval, size_t * oldlenp, void *newval,
- size_t newlen, void **context)
-{
- struct i2c_chips_data data;
- int i, oldlen, nrels, maxels,ret=0;
- struct ctl_table *client_tbl;
-
- if (oldval && oldlenp && !((ret = get_user(oldlen, oldlenp))) &&
- oldlen) {
- maxels = oldlen / sizeof(struct i2c_chips_data);
- nrels = 0;
- for (i = 0; (i < SENSORS_ENTRY_MAX) && (nrels < maxels);
- i++)
- if (i2c_entries[i]) {
- client_tbl - i2c_entries[i]->ctl_table->child->
- child;
- data.sysctl_id = client_tbl->ctl_name;
- strcpy(data.name, client_tbl->procname);
- if(copy_to_user(oldval, &data,
- sizeof(struct
- i2c_chips_data)))
- return -EFAULT;
- (char *) oldval +- sizeof(struct i2c_chips_data);
- nrels++;
- }
- oldlen = nrels * sizeof(struct i2c_chips_data);
- if(put_user(oldlen, oldlenp))
- return -EFAULT;
- }
- return ret;
-}
-
-
-/* This function reads or writes a 'real' value (encoded by the combination
- of an integer and a magnitude, the last is the power of ten the value
- should be divided with) to a /proc/sys directory. To use this function,
- you must (before registering the ctl_table) set the extra2 field to the
- client, and the extra1 field to a function of the form:
- void func(struct i2c_client *client, int operation, int ctl_name,
- int *nrels_mag, long *results)
- This function can be called for three values of operation. If operation
- equals SENSORS_PROC_REAL_INFO, the magnitude should be returned in
- nrels_mag. If operation equals SENSORS_PROC_REAL_READ, values should
- be read into results. nrels_mag should return the number of elements
- read; the maximum number is put in it on entry. Finally, if operation
- equals SENSORS_PROC_REAL_WRITE, the values in results should be
- written to the chip. nrels_mag contains on entry the number of elements
- found.
- In all cases, client points to the client we wish to interact with,
- and ctl_name is the SYSCTL id of the file we are accessing. */
-int i2c_proc_real(ctl_table * ctl, int write, struct file *filp,
- void *buffer, size_t * lenp)
-{
-#define MAX_RESULTS 32
- int mag, nrels = MAX_RESULTS;
- long results[MAX_RESULTS];
- i2c_real_callback callback = ctl->extra1;
- struct i2c_client *client = ctl->extra2;
- int res;
-
- /* If buffer is size 0, or we try to read when not at the start, we
- return nothing. Note that I think writing when not at the start
- does not work either, but anyway, this is straight from the kernel
- sources. */
- if (!*lenp || (filp->f_pos && !write)) {
- *lenp = 0;
- return 0;
- }
-
- /* Get the magnitude */
- callback(client, SENSORS_PROC_REAL_INFO, ctl->ctl_name, &mag,
- NULL);
-
- if (write) {
- /* Read the complete input into results, converting to longs */
- res = i2c_parse_reals(&nrels, buffer, *lenp, results, mag);
- if (res)
- return res;
-
- if (!nrels)
- return 0;
-
- /* Now feed this information back to the client */
- callback(client, SENSORS_PROC_REAL_WRITE, ctl->ctl_name,
- &nrels, results);
-
- filp->f_pos += *lenp;
- return 0;
- } else { /* read */
- /* Get the information from the client into results */
- callback(client, SENSORS_PROC_REAL_READ, ctl->ctl_name,
- &nrels, results);
-
- /* And write them to buffer, converting to reals */
- res = i2c_write_reals(nrels, buffer, lenp, results, mag);
- if (res)
- return res;
- filp->f_pos += *lenp;
- return 0;
- }
-}
-
-/* This function is equivalent to i2c_proc_real, only it interacts with
- the sysctl(2) syscall, and returns no reals, but integers */
-int i2c_sysctl_real(ctl_table * table, int *name, int nlen,
- void *oldval, size_t * oldlenp, void *newval,
- size_t newlen, void **context)
-{
- long results[MAX_RESULTS];
- int oldlen, nrels = MAX_RESULTS,ret=0;
- i2c_real_callback callback = table->extra1;
- struct i2c_client *client = table->extra2;
-
- /* Check if we need to output the old values */
- if (oldval && oldlenp && !((ret=get_user(oldlen, oldlenp))) && oldlen) {
- callback(client, SENSORS_PROC_REAL_READ, table->ctl_name,
- &nrels, results);
-
- /* Note the rounding factor! */
- if (nrels * sizeof(long) < oldlen)
- oldlen = nrels * sizeof(long);
- oldlen = (oldlen / sizeof(long)) * sizeof(long);
- if(copy_to_user(oldval, results, oldlen))
- return -EFAULT;
- if(put_user(oldlen, oldlenp))
- return -EFAULT;
- }
-
- if (newval && newlen) {
- /* Note the rounding factor! */
- newlen -= newlen % sizeof(long);
- nrels = newlen / sizeof(long);
- if(copy_from_user(results, newval, newlen))
- return -EFAULT;
-
- /* Get the new values back to the client */
- callback(client, SENSORS_PROC_REAL_WRITE, table->ctl_name,
- &nrels, results);
- }
- return ret;
-}
-
-
-/* nrels contains initially the maximum number of elements which can be
- put in results, and finally the number of elements actually put there.
- A magnitude of 1 will multiply everything with 10; etc.
- buffer, bufsize is the character buffer we read from and its length.
- results will finally contain the parsed integers.
-
- Buffer should contain several reals, separated by whitespace. A real
- has the following syntax:
- [ Minus ] Digit* [ Dot Digit* ]
- (everything between [] is optional; * means zero or more).
- When the next character is unparsable, everything is skipped until the
- next whitespace.
-
- WARNING! This is tricky code. I have tested it, but there may still be
- hidden bugs in it, even leading to crashes and things!
-*/
-static int i2c_parse_reals(int *nrels, void *buffer, int bufsize,
- long *results, int magnitude)
-{
- int maxels, min, mag;
- long res,ret=0;
- char nextchar = 0;
-
- maxels = *nrels;
- *nrels = 0;
-
- while (bufsize && (*nrels < maxels)) {
-
- /* Skip spaces at the start */
- while (bufsize &&
- !((ret=get_user(nextchar, (char *) buffer))) &&
- isspace((int) nextchar)) {
- bufsize--;
- ((char *) buffer)++;
- }
-
- if (ret)
- return -EFAULT;
- /* Well, we may be done now */
- if (!bufsize)
- return 0;
-
- /* New defaults for our result */
- min = 0;
- res = 0;
- mag = magnitude;
-
- /* Check for a minus */
- if (!((ret=get_user(nextchar, (char *) buffer)))
- && (nextchar = '-')) {
- min = 1;
- bufsize--;
- ((char *) buffer)++;
- }
- if (ret)
- return -EFAULT;
-
- /* Digits before a decimal dot */
- while (bufsize &&
- !((ret=get_user(nextchar, (char *) buffer))) &&
- isdigit((int) nextchar)) {
- res = res * 10 + nextchar - '0';
- bufsize--;
- ((char *) buffer)++;
- }
- if (ret)
- return -EFAULT;
-
- /* If mag < 0, we must actually divide here! */
- while (mag < 0) {
- res = res / 10;
- mag++;
- }
-
- if (bufsize && (nextchar = '.')) {
- /* Skip the dot */
- bufsize--;
- ((char *) buffer)++;
-
- /* Read digits while they are significant */
- while (bufsize && (mag > 0) &&
- !((ret=get_user(nextchar, (char *) buffer))) &&
- isdigit((int) nextchar)) {
- res = res * 10 + nextchar - '0';
- mag--;
- bufsize--;
- ((char *) buffer)++;
- }
- if (ret)
- return -EFAULT;
- }
- /* If we are out of data, but mag > 0, we need to scale here */
- while (mag > 0) {
- res = res * 10;
- mag--;
- }
-
- /* Skip everything until we hit whitespace */
- while (bufsize &&
- !((ret=get_user(nextchar, (char *) buffer))) &&
- isspace((int) nextchar)) {
- bufsize--;
- ((char *) buffer)++;
- }
- if (ret)
- return -EFAULT;
-
- /* Put res in results */
- results[*nrels] = (min ? -1 : 1) * res;
- (*nrels)++;
- }
-
- /* Well, there may be more in the buffer, but we need no more data.
- Ignore anything that is left. */
- return 0;
-}
-
-static int i2c_write_reals(int nrels, void *buffer, size_t *bufsize,
- long *results, int magnitude)
-{
-#define BUFLEN 20
- char BUF[BUFLEN + 1]; /* An individual representation should fit! */
- char printfstr[10];
- int nr = 0;
- int buflen, mag, times;
- int curbufsize = 0;
-
- while ((nr < nrels) && (curbufsize < *bufsize)) {
- mag = magnitude;
-
- if (nr != 0) {
- if(put_user(' ', (char *) buffer))
- return -EFAULT;
- curbufsize++;
- ((char *) buffer)++;
- }
-
- /* Fill BUF with the representation of the next string */
- if (mag <= 0) {
- buflen = sprintf(BUF, "%ld", results[nr]);
- if (buflen < 0) { /* Oops, a sprintf error! */
- *bufsize = 0;
- return -EINVAL;
- }
- while ((mag < 0) && (buflen < BUFLEN)) {
- BUF[buflen++] = '0';
- mag++;
- }
- BUF[buflen] = 0;
- } else {
- times = 1;
- for (times = 1; mag-- > 0; times *= 10);
- if (results[nr] < 0) {
- BUF[0] = '-';
- buflen = 1;
- } else
- buflen = 0;
- strcpy(printfstr, "%ld.%0Xld");
- printfstr[6] = magnitude + '0';
- buflen +- sprintf(BUF + buflen, printfstr,
- abs(results[nr]) / times,
- abs(results[nr]) % times);
- if (buflen < 0) { /* Oops, a sprintf error! */
- *bufsize = 0;
- return -EINVAL;
- }
- }
-
- /* Now copy it to the user-space buffer */
- if (buflen + curbufsize > *bufsize)
- buflen = *bufsize - curbufsize;
- if(copy_to_user(buffer, BUF, buflen))
- return -EFAULT;
- curbufsize += buflen;
- (char *) buffer += buflen;
-
- nr++;
- }
- if (curbufsize < *bufsize) {
- if(put_user('\n', (char *) buffer))
- return -EFAULT;
- curbufsize++;
- }
- *bufsize = curbufsize;
- return 0;
-}
-
/* Very inefficient for ISA detects, and won't work for 10-bit addresses! */
int i2c_detect(struct i2c_adapter *adapter,
@@ -703,26 +170,13 @@
static int __init i2c_proc_init(void)
{
- printk(KERN_INFO "i2c-proc.o version %s (%s)\n", I2C_VERSION, I2C_DATE);
- if (!
- (i2c_proc_header - register_sysctl_table(i2c_proc, 0))) {
- printk(KERN_ERR "i2c-proc.o: error: sysctl interface not supported by kernel!\n");
- return -EPERM;
- }
- i2c_proc_header->ctl_table->child->de->owner = THIS_MODULE;
return 0;
}
static void __exit i2c_proc_exit(void)
{
- unregister_sysctl_table(i2c_proc_header);
}
-EXPORT_SYMBOL(i2c_register_entry);
-EXPORT_SYMBOL(i2c_deregister_entry);
-EXPORT_SYMBOL(i2c_proc_real);
-EXPORT_SYMBOL(i2c_sysctl_real);
EXPORT_SYMBOL(i2c_detect);
MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>");
diff -Nru a/include/linux/i2c-proc.h b/include/linux/i2c-proc.h
--- a/include/linux/i2c-proc.h Wed Apr 2 16:01:04 2003
+++ b/include/linux/i2c-proc.h Wed Apr 2 16:01:04 2003
@@ -34,46 +34,6 @@
#define SENSORS_PROC_REAL_READ 2
#define SENSORS_PROC_REAL_WRITE 3
-/* These funcion reads or writes a 'real' value (encoded by the combination
- of an integer and a magnitude, the last is the power of ten the value
- should be divided with) to a /proc/sys directory. To use these functions,
- you must (before registering the ctl_table) set the extra2 field to the
- client, and the extra1 field to a function of the form:
- void func(struct i2c_client *client, int operation, int ctl_name,
- int *nrels_mag, long *results)
- This last function can be called for three values of operation. If
- operation equals SENSORS_PROC_REAL_INFO, the magnitude should be returned
- in nrels_mag. If operation equals SENSORS_PROC_REAL_READ, values should
- be read into results. nrels_mag should return the number of elements
- read; the maximum number is put in it on entry. Finally, if operation
- equals SENSORS_PROC_REAL_WRITE, the values in results should be
- written to the chip. nrels_mag contains on entry the number of elements
- found.
- In all cases, client points to the client we wish to interact with,
- and ctl_name is the SYSCTL id of the file we are accessing. */
-extern int i2c_sysctl_real(ctl_table * table, int *name, int nlen,
- void *oldval, size_t * oldlenp,
- void *newval, size_t newlen,
- void **context);
-extern int i2c_proc_real(ctl_table * ctl, int write, struct file *filp,
- void *buffer, size_t * lenp);
-
-
-
-/* These rather complex functions must be called when you want to add or
- delete an entry in /proc/sys/dev/sensors/chips (not yet implemented). It
- also creates a new directory within /proc/sys/dev/sensors/.
- ctl_template should be a template of the newly created directory. It is
- copied in memory. The extra2 field of each file is set to point to client.
- If any driver wants subdirectories within the newly created directory,
- these functions must be updated! */
-extern int i2c_register_entry(struct i2c_client *client,
- const char *prefix,
- ctl_table * ctl_template);
-
-extern void i2c_deregister_entry(int id);
-
-
/* A structure containing detect information.
Force variables overrule all other variables; they force a detection on
that place. If a specific chip is given, the module blindly assumes this
WARNING: multiple messages have this Message-ID (diff)
From: Greg KH <greg@kroah.com>
To: linux-kernel@vger.kernel.org, sensors@stimpy.netroedge.com
Subject: Re: [PATCH] More i2c driver changes for 2.5.66
Date: Wed, 2 Apr 2003 16:15:58 -0800 [thread overview]
Message-ID: <1049328958830@kroah.com> (raw)
In-Reply-To: <10493289582408@kroah.com>
ChangeSet 1.977.29.8, 2003/04/02 11:45:21-08:00, greg@kroah.com
i2c: remove proc and sysctl code from i2c-proc as it is no longer used.
drivers/i2c/i2c-proc.c | 546 -----------------------------------------------
include/linux/i2c-proc.h | 40 ---
2 files changed, 586 deletions(-)
diff -Nru a/drivers/i2c/i2c-proc.c b/drivers/i2c/i2c-proc.c
--- a/drivers/i2c/i2c-proc.c Wed Apr 2 16:01:04 2003
+++ b/drivers/i2c/i2c-proc.c Wed Apr 2 16:01:04 2003
@@ -37,539 +37,6 @@
#include <linux/i2c-proc.h>
#include <asm/uaccess.h>
-static int i2c_parse_reals(int *nrels, void *buffer, int bufsize,
- long *results, int magnitude);
-static int i2c_write_reals(int nrels, void *buffer, size_t *bufsize,
- long *results, int magnitude);
-static int i2c_proc_chips(ctl_table * ctl, int write,
- struct file *filp, void *buffer,
- size_t * lenp);
-static int i2c_sysctl_chips(ctl_table * table, int *name, int nlen,
- void *oldval, size_t * oldlenp,
- void *newval, size_t newlen,
- void **context);
-
-#define SENSORS_ENTRY_MAX 20
-static struct ctl_table_header *i2c_entries[SENSORS_ENTRY_MAX];
-
-static struct i2c_client *i2c_clients[SENSORS_ENTRY_MAX];
-
-static ctl_table i2c_proc_dev_sensors[] = {
- {SENSORS_CHIPS, "chips", NULL, 0, 0644, NULL, &i2c_proc_chips,
- &i2c_sysctl_chips},
- {0}
-};
-
-static ctl_table i2c_proc_dev[] = {
- {DEV_SENSORS, "sensors", NULL, 0, 0555, i2c_proc_dev_sensors},
- {0},
-};
-
-
-static ctl_table i2c_proc[] = {
- {CTL_DEV, "dev", NULL, 0, 0555, i2c_proc_dev},
- {0}
-};
-
-
-static struct ctl_table_header *i2c_proc_header;
-
-/* This returns a nice name for a new directory; for example lm78-isa-0310
- (for a LM78 chip on the ISA bus at port 0x310), or lm75-i2c-3-4e (for
- a LM75 chip on the third i2c bus at address 0x4e).
- name is allocated first. */
-static char *generate_name(struct i2c_client *client, const char *prefix)
-{
- struct i2c_adapter *adapter = client->adapter;
- int addr = client->addr;
- char name_buffer[50], *name;
-
- if (i2c_is_isa_adapter(adapter)) {
- sprintf(name_buffer, "%s-isa-%04x", prefix, addr);
- } else if (adapter->algo->smbus_xfer || adapter->algo->master_xfer) {
- int id = i2c_adapter_id(adapter);
- if (id < 0)
- return ERR_PTR(-ENOENT);
- sprintf(name_buffer, "%s-i2c-%d-%02x", prefix, id, addr);
- } else { /* dummy adapter, generate prefix */
- int end, i;
-
- sprintf(name_buffer, "%s-", prefix);
- end = strlen(name_buffer);
-
- for (i = 0; i < 32; i++) {
- if (adapter->algo->name[i] == ' ')
- break;
- name_buffer[end++] = tolower(adapter->algo->name[i]);
- }
-
- name_buffer[end] = 0;
- sprintf(name_buffer + end, "-%04x", addr);
- }
-
- name = kmalloc(strlen(name_buffer) + 1, GFP_KERNEL);
- if (unlikely(!name))
- return ERR_PTR(-ENOMEM);
- strcpy(name, name_buffer);
- return name;
-}
-
-/* This rather complex function must be called when you want to add an entry
- to /proc/sys/dev/sensors/chips. It also creates a new directory within
- /proc/sys/dev/sensors/.
- ctl_template should be a template of the newly created directory. It is
- copied in memory. The extra2 field of each file is set to point to client.
- If any driver wants subdirectories within the newly created directory,
- this function must be updated! */
-int i2c_register_entry(struct i2c_client *client, const char *prefix,
- struct ctl_table *leaf)
-{
- struct { struct ctl_table root[2], dev[2], sensors[2]; } *tbl;
- struct ctl_table_header *hdr;
- struct ctl_table *tmp;
- const char *name;
- int id;
-
- name = generate_name(client, prefix);
- if (IS_ERR(name))
- return PTR_ERR(name);
-
- for (id = 0; id < SENSORS_ENTRY_MAX; id++) {
- if (!i2c_entries[id])
- goto free_slot;
- }
-
- goto out_free_name;
-
- free_slot:
- tbl = kmalloc(sizeof(*tbl), GFP_KERNEL);
- if (unlikely(!tbl))
- goto out_free_name;
- memset(tbl, 0, sizeof(*tbl));
-
- for (tmp = leaf; tmp->ctl_name; tmp++)
- tmp->extra2 = client;
-
- tbl->sensors->ctl_name = id+256;
- tbl->sensors->procname = name;
- tbl->sensors->mode = 0555;
- tbl->sensors->child = leaf;
-
- tbl->dev->ctl_name = DEV_SENSORS;
- tbl->dev->procname = "sensors";
- tbl->dev->mode = 0555;
- tbl->dev->child = tbl->sensors;
-
- tbl->root->ctl_name = CTL_DEV;
- tbl->root->procname = "dev";
- tbl->root->mode = 0555;
- tbl->root->child = tbl->dev;
-
- hdr = register_sysctl_table(tbl->root, 0);
- if (unlikely(!hdr))
- goto out_free_tbl;
-
- i2c_entries[id] = hdr;
- i2c_clients[id] = client;
-
- return (id + 256); /* XXX(hch) why?? */
-
- out_free_tbl:
- kfree(tbl);
- out_free_name:
- kfree(name);
- return -ENOMEM;
-}
-
-void i2c_deregister_entry(int id)
-{
- id -= 256;
-
- if (i2c_entries[id]) {
- struct ctl_table_header *hdr = i2c_entries[id];
- struct ctl_table *tbl = hdr->ctl_table;
-
- unregister_sysctl_table(hdr);
- kfree(tbl->child->child->procname);
- kfree(tbl); /* actually the whole anonymous struct */
- }
-
- i2c_entries[id] = NULL;
- i2c_clients[id] = NULL;
-}
-
-static int i2c_proc_chips(ctl_table * ctl, int write, struct file *filp,
- void *buffer, size_t * lenp)
-{
- char BUF[SENSORS_PREFIX_MAX + 30];
- int buflen, curbufsize, i;
- struct ctl_table *client_tbl;
-
- if (write)
- return 0;
-
- /* If buffer is size 0, or we try to read when not at the start, we
- return nothing. Note that I think writing when not at the start
- does not work either, but anyway, this is straight from the kernel
- sources. */
- if (!*lenp || (filp->f_pos && !write)) {
- *lenp = 0;
- return 0;
- }
- curbufsize = 0;
- for (i = 0; i < SENSORS_ENTRY_MAX; i++)
- if (i2c_entries[i]) {
- client_tbl =
- i2c_entries[i]->ctl_table->child->child;
- buflen =
- sprintf(BUF, "%d\t%s\n", client_tbl->ctl_name,
- client_tbl->procname);
- if (buflen + curbufsize > *lenp)
- buflen = *lenp - curbufsize;
- if(copy_to_user(buffer, BUF, buflen))
- return -EFAULT;
- curbufsize += buflen;
- (char *) buffer += buflen;
- }
- *lenp = curbufsize;
- filp->f_pos += curbufsize;
- return 0;
-}
-
-static int i2c_sysctl_chips(ctl_table * table, int *name, int nlen,
- void *oldval, size_t * oldlenp, void *newval,
- size_t newlen, void **context)
-{
- struct i2c_chips_data data;
- int i, oldlen, nrels, maxels,ret=0;
- struct ctl_table *client_tbl;
-
- if (oldval && oldlenp && !((ret = get_user(oldlen, oldlenp))) &&
- oldlen) {
- maxels = oldlen / sizeof(struct i2c_chips_data);
- nrels = 0;
- for (i = 0; (i < SENSORS_ENTRY_MAX) && (nrels < maxels);
- i++)
- if (i2c_entries[i]) {
- client_tbl =
- i2c_entries[i]->ctl_table->child->
- child;
- data.sysctl_id = client_tbl->ctl_name;
- strcpy(data.name, client_tbl->procname);
- if(copy_to_user(oldval, &data,
- sizeof(struct
- i2c_chips_data)))
- return -EFAULT;
- (char *) oldval +=
- sizeof(struct i2c_chips_data);
- nrels++;
- }
- oldlen = nrels * sizeof(struct i2c_chips_data);
- if(put_user(oldlen, oldlenp))
- return -EFAULT;
- }
- return ret;
-}
-
-
-/* This function reads or writes a 'real' value (encoded by the combination
- of an integer and a magnitude, the last is the power of ten the value
- should be divided with) to a /proc/sys directory. To use this function,
- you must (before registering the ctl_table) set the extra2 field to the
- client, and the extra1 field to a function of the form:
- void func(struct i2c_client *client, int operation, int ctl_name,
- int *nrels_mag, long *results)
- This function can be called for three values of operation. If operation
- equals SENSORS_PROC_REAL_INFO, the magnitude should be returned in
- nrels_mag. If operation equals SENSORS_PROC_REAL_READ, values should
- be read into results. nrels_mag should return the number of elements
- read; the maximum number is put in it on entry. Finally, if operation
- equals SENSORS_PROC_REAL_WRITE, the values in results should be
- written to the chip. nrels_mag contains on entry the number of elements
- found.
- In all cases, client points to the client we wish to interact with,
- and ctl_name is the SYSCTL id of the file we are accessing. */
-int i2c_proc_real(ctl_table * ctl, int write, struct file *filp,
- void *buffer, size_t * lenp)
-{
-#define MAX_RESULTS 32
- int mag, nrels = MAX_RESULTS;
- long results[MAX_RESULTS];
- i2c_real_callback callback = ctl->extra1;
- struct i2c_client *client = ctl->extra2;
- int res;
-
- /* If buffer is size 0, or we try to read when not at the start, we
- return nothing. Note that I think writing when not at the start
- does not work either, but anyway, this is straight from the kernel
- sources. */
- if (!*lenp || (filp->f_pos && !write)) {
- *lenp = 0;
- return 0;
- }
-
- /* Get the magnitude */
- callback(client, SENSORS_PROC_REAL_INFO, ctl->ctl_name, &mag,
- NULL);
-
- if (write) {
- /* Read the complete input into results, converting to longs */
- res = i2c_parse_reals(&nrels, buffer, *lenp, results, mag);
- if (res)
- return res;
-
- if (!nrels)
- return 0;
-
- /* Now feed this information back to the client */
- callback(client, SENSORS_PROC_REAL_WRITE, ctl->ctl_name,
- &nrels, results);
-
- filp->f_pos += *lenp;
- return 0;
- } else { /* read */
- /* Get the information from the client into results */
- callback(client, SENSORS_PROC_REAL_READ, ctl->ctl_name,
- &nrels, results);
-
- /* And write them to buffer, converting to reals */
- res = i2c_write_reals(nrels, buffer, lenp, results, mag);
- if (res)
- return res;
- filp->f_pos += *lenp;
- return 0;
- }
-}
-
-/* This function is equivalent to i2c_proc_real, only it interacts with
- the sysctl(2) syscall, and returns no reals, but integers */
-int i2c_sysctl_real(ctl_table * table, int *name, int nlen,
- void *oldval, size_t * oldlenp, void *newval,
- size_t newlen, void **context)
-{
- long results[MAX_RESULTS];
- int oldlen, nrels = MAX_RESULTS,ret=0;
- i2c_real_callback callback = table->extra1;
- struct i2c_client *client = table->extra2;
-
- /* Check if we need to output the old values */
- if (oldval && oldlenp && !((ret=get_user(oldlen, oldlenp))) && oldlen) {
- callback(client, SENSORS_PROC_REAL_READ, table->ctl_name,
- &nrels, results);
-
- /* Note the rounding factor! */
- if (nrels * sizeof(long) < oldlen)
- oldlen = nrels * sizeof(long);
- oldlen = (oldlen / sizeof(long)) * sizeof(long);
- if(copy_to_user(oldval, results, oldlen))
- return -EFAULT;
- if(put_user(oldlen, oldlenp))
- return -EFAULT;
- }
-
- if (newval && newlen) {
- /* Note the rounding factor! */
- newlen -= newlen % sizeof(long);
- nrels = newlen / sizeof(long);
- if(copy_from_user(results, newval, newlen))
- return -EFAULT;
-
- /* Get the new values back to the client */
- callback(client, SENSORS_PROC_REAL_WRITE, table->ctl_name,
- &nrels, results);
- }
- return ret;
-}
-
-
-/* nrels contains initially the maximum number of elements which can be
- put in results, and finally the number of elements actually put there.
- A magnitude of 1 will multiply everything with 10; etc.
- buffer, bufsize is the character buffer we read from and its length.
- results will finally contain the parsed integers.
-
- Buffer should contain several reals, separated by whitespace. A real
- has the following syntax:
- [ Minus ] Digit* [ Dot Digit* ]
- (everything between [] is optional; * means zero or more).
- When the next character is unparsable, everything is skipped until the
- next whitespace.
-
- WARNING! This is tricky code. I have tested it, but there may still be
- hidden bugs in it, even leading to crashes and things!
-*/
-static int i2c_parse_reals(int *nrels, void *buffer, int bufsize,
- long *results, int magnitude)
-{
- int maxels, min, mag;
- long res,ret=0;
- char nextchar = 0;
-
- maxels = *nrels;
- *nrels = 0;
-
- while (bufsize && (*nrels < maxels)) {
-
- /* Skip spaces at the start */
- while (bufsize &&
- !((ret=get_user(nextchar, (char *) buffer))) &&
- isspace((int) nextchar)) {
- bufsize--;
- ((char *) buffer)++;
- }
-
- if (ret)
- return -EFAULT;
- /* Well, we may be done now */
- if (!bufsize)
- return 0;
-
- /* New defaults for our result */
- min = 0;
- res = 0;
- mag = magnitude;
-
- /* Check for a minus */
- if (!((ret=get_user(nextchar, (char *) buffer)))
- && (nextchar == '-')) {
- min = 1;
- bufsize--;
- ((char *) buffer)++;
- }
- if (ret)
- return -EFAULT;
-
- /* Digits before a decimal dot */
- while (bufsize &&
- !((ret=get_user(nextchar, (char *) buffer))) &&
- isdigit((int) nextchar)) {
- res = res * 10 + nextchar - '0';
- bufsize--;
- ((char *) buffer)++;
- }
- if (ret)
- return -EFAULT;
-
- /* If mag < 0, we must actually divide here! */
- while (mag < 0) {
- res = res / 10;
- mag++;
- }
-
- if (bufsize && (nextchar == '.')) {
- /* Skip the dot */
- bufsize--;
- ((char *) buffer)++;
-
- /* Read digits while they are significant */
- while (bufsize && (mag > 0) &&
- !((ret=get_user(nextchar, (char *) buffer))) &&
- isdigit((int) nextchar)) {
- res = res * 10 + nextchar - '0';
- mag--;
- bufsize--;
- ((char *) buffer)++;
- }
- if (ret)
- return -EFAULT;
- }
- /* If we are out of data, but mag > 0, we need to scale here */
- while (mag > 0) {
- res = res * 10;
- mag--;
- }
-
- /* Skip everything until we hit whitespace */
- while (bufsize &&
- !((ret=get_user(nextchar, (char *) buffer))) &&
- isspace((int) nextchar)) {
- bufsize--;
- ((char *) buffer)++;
- }
- if (ret)
- return -EFAULT;
-
- /* Put res in results */
- results[*nrels] = (min ? -1 : 1) * res;
- (*nrels)++;
- }
-
- /* Well, there may be more in the buffer, but we need no more data.
- Ignore anything that is left. */
- return 0;
-}
-
-static int i2c_write_reals(int nrels, void *buffer, size_t *bufsize,
- long *results, int magnitude)
-{
-#define BUFLEN 20
- char BUF[BUFLEN + 1]; /* An individual representation should fit! */
- char printfstr[10];
- int nr = 0;
- int buflen, mag, times;
- int curbufsize = 0;
-
- while ((nr < nrels) && (curbufsize < *bufsize)) {
- mag = magnitude;
-
- if (nr != 0) {
- if(put_user(' ', (char *) buffer))
- return -EFAULT;
- curbufsize++;
- ((char *) buffer)++;
- }
-
- /* Fill BUF with the representation of the next string */
- if (mag <= 0) {
- buflen = sprintf(BUF, "%ld", results[nr]);
- if (buflen < 0) { /* Oops, a sprintf error! */
- *bufsize = 0;
- return -EINVAL;
- }
- while ((mag < 0) && (buflen < BUFLEN)) {
- BUF[buflen++] = '0';
- mag++;
- }
- BUF[buflen] = 0;
- } else {
- times = 1;
- for (times = 1; mag-- > 0; times *= 10);
- if (results[nr] < 0) {
- BUF[0] = '-';
- buflen = 1;
- } else
- buflen = 0;
- strcpy(printfstr, "%ld.%0Xld");
- printfstr[6] = magnitude + '0';
- buflen +=
- sprintf(BUF + buflen, printfstr,
- abs(results[nr]) / times,
- abs(results[nr]) % times);
- if (buflen < 0) { /* Oops, a sprintf error! */
- *bufsize = 0;
- return -EINVAL;
- }
- }
-
- /* Now copy it to the user-space buffer */
- if (buflen + curbufsize > *bufsize)
- buflen = *bufsize - curbufsize;
- if(copy_to_user(buffer, BUF, buflen))
- return -EFAULT;
- curbufsize += buflen;
- (char *) buffer += buflen;
-
- nr++;
- }
- if (curbufsize < *bufsize) {
- if(put_user('\n', (char *) buffer))
- return -EFAULT;
- curbufsize++;
- }
- *bufsize = curbufsize;
- return 0;
-}
-
/* Very inefficient for ISA detects, and won't work for 10-bit addresses! */
int i2c_detect(struct i2c_adapter *adapter,
@@ -703,26 +170,13 @@
static int __init i2c_proc_init(void)
{
- printk(KERN_INFO "i2c-proc.o version %s (%s)\n", I2C_VERSION, I2C_DATE);
- if (!
- (i2c_proc_header =
- register_sysctl_table(i2c_proc, 0))) {
- printk(KERN_ERR "i2c-proc.o: error: sysctl interface not supported by kernel!\n");
- return -EPERM;
- }
- i2c_proc_header->ctl_table->child->de->owner = THIS_MODULE;
return 0;
}
static void __exit i2c_proc_exit(void)
{
- unregister_sysctl_table(i2c_proc_header);
}
-EXPORT_SYMBOL(i2c_register_entry);
-EXPORT_SYMBOL(i2c_deregister_entry);
-EXPORT_SYMBOL(i2c_proc_real);
-EXPORT_SYMBOL(i2c_sysctl_real);
EXPORT_SYMBOL(i2c_detect);
MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>");
diff -Nru a/include/linux/i2c-proc.h b/include/linux/i2c-proc.h
--- a/include/linux/i2c-proc.h Wed Apr 2 16:01:04 2003
+++ b/include/linux/i2c-proc.h Wed Apr 2 16:01:04 2003
@@ -34,46 +34,6 @@
#define SENSORS_PROC_REAL_READ 2
#define SENSORS_PROC_REAL_WRITE 3
-/* These funcion reads or writes a 'real' value (encoded by the combination
- of an integer and a magnitude, the last is the power of ten the value
- should be divided with) to a /proc/sys directory. To use these functions,
- you must (before registering the ctl_table) set the extra2 field to the
- client, and the extra1 field to a function of the form:
- void func(struct i2c_client *client, int operation, int ctl_name,
- int *nrels_mag, long *results)
- This last function can be called for three values of operation. If
- operation equals SENSORS_PROC_REAL_INFO, the magnitude should be returned
- in nrels_mag. If operation equals SENSORS_PROC_REAL_READ, values should
- be read into results. nrels_mag should return the number of elements
- read; the maximum number is put in it on entry. Finally, if operation
- equals SENSORS_PROC_REAL_WRITE, the values in results should be
- written to the chip. nrels_mag contains on entry the number of elements
- found.
- In all cases, client points to the client we wish to interact with,
- and ctl_name is the SYSCTL id of the file we are accessing. */
-extern int i2c_sysctl_real(ctl_table * table, int *name, int nlen,
- void *oldval, size_t * oldlenp,
- void *newval, size_t newlen,
- void **context);
-extern int i2c_proc_real(ctl_table * ctl, int write, struct file *filp,
- void *buffer, size_t * lenp);
-
-
-
-/* These rather complex functions must be called when you want to add or
- delete an entry in /proc/sys/dev/sensors/chips (not yet implemented). It
- also creates a new directory within /proc/sys/dev/sensors/.
- ctl_template should be a template of the newly created directory. It is
- copied in memory. The extra2 field of each file is set to point to client.
- If any driver wants subdirectories within the newly created directory,
- these functions must be updated! */
-extern int i2c_register_entry(struct i2c_client *client,
- const char *prefix,
- ctl_table * ctl_template);
-
-extern void i2c_deregister_entry(int id);
-
-
/* A structure containing detect information.
Force variables overrule all other variables; they force a detection on
that place. If a specific chip is given, the module blindly assumes this
next prev parent reply other threads:[~2005-05-19 6:23 UTC|newest]
Thread overview: 92+ messages / expand[flat|nested] mbox.gz Atom feed top
2003-04-03 0:14 [BK PATCH] More i2c driver changes for 2.5.66 Greg KH
2003-04-03 0:15 ` [PATCH] " Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH [this message]
2005-05-19 6:23 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 0:15 ` Greg KH
2003-04-03 6:21 ` Albert Cranford
2005-05-19 6:23 ` Albert Cranford
2003-04-03 6:33 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-04-03 13:06 ` Albert Cranford
2005-05-19 6:23 ` Albert Cranford
2003-04-03 16:37 ` Greg KH
2005-05-19 6:23 ` Greg KH
-- strict thread matches above, loose matches on Subject: below --
2003-06-11 20:35 [BK PATCH] More i2c driver changes for 2.5.70 Greg KH
2005-05-19 6:23 ` Greg KH
2003-06-11 20:36 ` [PATCH] " Greg KH
2005-05-19 6:23 ` Greg KH
2003-06-11 20:36 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-06-11 20:36 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-06-11 20:36 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-06-11 20:36 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-06-11 20:36 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-06-12 2:40 ` Philip Pokorny
2005-05-19 6:23 ` Philip Pokorny
2003-05-09 23:55 [BK PATCH] More i2c driver changes for 2.5.69 Greg KH
2005-05-19 6:23 ` Greg KH
2003-05-09 23:56 ` [PATCH] " Greg KH
2005-05-19 6:23 ` Greg KH
2003-05-09 23:56 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-05-09 23:56 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-05-09 23:56 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-05-09 23:56 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-05-09 23:56 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-22 1:04 [BK PATCH] More i2c driver changes for 2.5.65 Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-22 1:04 ` [PATCH] " Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-22 1:04 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-22 1:04 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-22 1:04 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-22 1:04 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-22 1:04 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-22 1:04 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-22 1:04 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-22 1:04 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-25 9:35 ` Pavel Machek
2005-05-19 6:23 ` Pavel Machek
2003-03-25 1:29 ` Greg KH
2005-05-19 6:23 ` Greg KH
2003-03-25 2:04 ` Dave Jones
2005-05-19 6:23 ` Dave Jones
2003-03-25 3:34 ` Greg KH
2005-05-19 6:23 ` Greg KH
2005-05-19 6:23 ` [PATCH] More i2c driver changes for 2.5.66 Mark M. Hoffman
2005-05-19 6:23 ` Albert Cranford
2005-05-19 6:23 ` Greg KH
2005-05-19 6:23 ` [PATCH] More i2c driver changes for 2.5.69 Philip Pokorny
2003-03-22 2:33 ` [PATCH] More i2c driver changes for 2.5.65 Petr Vandrovec
2005-05-19 6:23 ` Petr Vandrovec
2003-03-23 8:49 ` Greg KH
2005-05-19 6:23 ` Greg KH
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1049328958830@kroah.com \
--to=greg@kroah.com \
--cc=linux-kernel@vger.kernel.org \
--cc=sensors@stimpy.netroedge.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.