e1000_proc.c

来自「是关于linux2.5.1的完全源码」· C语言 代码 · 共 745 行 · 第 1/2 页

/*******************************************************************************

  This software program is available to you under a choice of one of two
  licenses. You may choose to be licensed under either the GNU General Public
  License 2.0, June 1991, available at http://www.fsf.org/copyleft/gpl.html,
  or the Intel BSD + Patent License, the text of which follows:
  
  Recipient has requested a license and Intel Corporation ("Intel") is willing
  to grant a license for the software entitled Linux Base Driver for the
  Intel(R) PRO/1000 Family of Adapters (e1000) (the "Software") being provided
  by Intel Corporation. The following definitions apply to this license:
  
  "Licensed Patents" means patent claims licensable by Intel Corporation which
  are necessarily infringed by the use of sale of the Software alone or when
  combined with the operating system referred to below.
  
  "Recipient" means the party to whom Intel delivers this Software.
  
  "Licensee" means Recipient and those third parties that receive a license to
  any operating system available under the GNU General Public License 2.0 or
  later.
  
  Copyright (c) 1999 - 2002 Intel Corporation.
  All rights reserved.
  
  The license is provided to Recipient and Recipient's Licensees under the
  following terms.
  
  Redistribution and use in source and binary forms of the Software, with or
  without modification, are permitted provided that the following conditions
  are met:
  
  Redistributions of source code of the Software may retain the above
  copyright notice, this list of conditions and the following disclaimer.
  
  Redistributions in binary form of the Software may reproduce the above
  copyright notice, this list of conditions and the following disclaimer in
  the documentation and/or materials provided with the distribution.
  
  Neither the name of Intel Corporation nor the names of its contributors
  shall be used to endorse or promote products derived from this Software
  without specific prior written permission.
  
  Intel hereby grants Recipient and Licensees a non-exclusive, worldwide,
  royalty-free patent license under Licensed Patents to make, use, sell, offer
  to sell, import and otherwise transfer the Software, if any, in source code
  and object code form. This license shall include changes to the Software
  that are error corrections or other minor changes to the Software that do
  not add functionality or features when the Software is incorporated in any
  version of an operating system that has been distributed under the GNU
  General Public License 2.0 or later. This patent license shall apply to the
  combination of the Software and any operating system licensed under the GNU
  General Public License 2.0 or later if, at the time Intel provides the
  Software to Recipient, such addition of the Software to the then publicly
  available versions of such operating systems available under the GNU General
  Public License 2.0 or later (whether in gold, beta or alpha form) causes
  such combination to be covered by the Licensed Patents. The patent license
  shall not apply to any other combinations which include the Software. NO
  hardware per se is licensed hereunder.
  
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MECHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR IT CONTRIBUTORS BE LIABLE FOR ANY
  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  (INCLUDING, BUT NOT LIMITED, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  ANY LOSS OF USE; DATA, OR PROFITS; OR BUSINESS INTERUPTION) HOWEVER CAUSED
  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*******************************************************************************/

/*
 * Proc fs support.
 *
 * Read-only files created by driver (if CONFIG_PROC_FS):
 *
 * /proc/net/PRO_LAN_Adapters/<ethx>.info
 * /proc/net/PRO_LAN_Adapters/<ethx>/<attribute>
 *
 * where <ethx>      is the system device name, i.e eth0.
 *       <attribute> is the driver attribute name.
 *
 * There is one file for each driver attribute, where the contents
 * of the file is the attribute value.  The ethx.info file contains
 * a list of all driver attributes in one file.
 *
 */

#include "e1000.h"

#ifdef CONFIG_PROC_FS

#include <linux/proc_fs.h>

#define ADAPTERS_PROC_DIR           "PRO_LAN_Adapters"
#define TAG_MAX_LENGTH              32
#define LINE_MAX_LENGTH             80
#define FIELD_MAX_LENGTH            LINE_MAX_LENGTH - TAG_MAX_LENGTH - 3

extern char e1000_driver_name[];
extern char e1000_driver_version[];

/*
 * The list of driver proc attributes is stored in a proc_list link
 * list.  The list is build with proc_list_setup and is used to
 * build the proc fs nodes.  The private data for each node is the
 * corresponding link in the link list.
 */

struct proc_list {
	struct list_head list;                  /* link list */
	char tag[TAG_MAX_LENGTH + 1];           /* attribute name */
	void *data;                             /* attribute data */
	size_t len;				/* sizeof data */
	char *(*func)(void *, size_t, char *);  /* format data func */
};

static int
e1000_proc_read(char *page, char **start, off_t off, int count, int *eof)
{
	int len = strlen(page);

	page[len++] = '\n';

	if(len <= off + count)
		*eof = 1;
	*start = page + off;
	len -= off;
	if(len > count)
		len = count;
	if(len < 0)
		len = 0;

	return len;
}

static int
e1000_proc_info_read(char *page, char **start, off_t off,
                     int count, int *eof, void *data)
{
	struct list_head *proc_list_head = data, *curr;
	struct proc_list *elem;
	char *p = page;
	char buf[FIELD_MAX_LENGTH + 1];

	list_for_each(curr, proc_list_head) {
		elem = list_entry(curr, struct proc_list, list);

		if (p - page + LINE_MAX_LENGTH >= PAGE_SIZE)
			break;

		if(!strlen(elem->tag))
			p += sprintf(p, "\n");
		else
			p += sprintf(p, "%-*.*s %.*s\n", 
				TAG_MAX_LENGTH, TAG_MAX_LENGTH,
				elem->tag, FIELD_MAX_LENGTH,
				elem->func(elem->data, elem->len, buf));
	}

	*p = '\0';

	return e1000_proc_read(page, start, off, count, eof);
}

static int
e1000_proc_single_read(char *page, char **start, off_t off,
                       int count, int *eof, void *data)
{
	struct proc_list *elem = data;

	sprintf(page, "%.*s", FIELD_MAX_LENGTH, elem->func(elem->data, 
	        elem->len, page));

	return e1000_proc_read(page, start, off, count, eof);
}

static void __devexit
e1000_proc_dirs_free(char *name, struct list_head *proc_list_head)
{
	struct proc_dir_entry *intel_proc_dir, *proc_dir;
	char info_name[strlen(name) + strlen(".info")];

	for(intel_proc_dir = proc_net->subdir; intel_proc_dir;
		intel_proc_dir = intel_proc_dir->next) {
		if((intel_proc_dir->namelen == strlen(ADAPTERS_PROC_DIR)) &&
		   !memcmp(intel_proc_dir->name, ADAPTERS_PROC_DIR, strlen(ADAPTERS_PROC_DIR)))
			break;
	}

	if(!intel_proc_dir)
		return;

	for(proc_dir = intel_proc_dir->subdir; proc_dir;
		proc_dir = proc_dir->next) {
		if ((proc_dir->namelen == strlen(name)) &&
		    !memcmp(proc_dir->name, name, strlen(name)))
			break;
	}

	if(proc_dir) {
		struct list_head *curr;
		struct proc_list *elem;

		list_for_each(curr, proc_list_head) {
			elem = list_entry(curr, struct proc_list, list);
			remove_proc_entry(elem->tag, proc_dir);
		}

		strcpy(info_name, name);
		strcat(info_name, ".info");

		remove_proc_entry(info_name, intel_proc_dir);
		remove_proc_entry(name, intel_proc_dir);
	}

	/* If the intel dir is empty, remove it */

	for(proc_dir = intel_proc_dir->subdir; proc_dir;
		proc_dir = proc_dir->next) {

		/* ignore . and .. */

		if(*(proc_dir->name) == '.')
			continue;
		break;
	}

	if(!proc_dir)
		remove_proc_entry(ADAPTERS_PROC_DIR, proc_net);
}


static int __devinit
e1000_proc_singles_create(struct proc_dir_entry *parent,
                          struct list_head *proc_list_head)
{
	struct list_head *curr;
	struct proc_list *elem;

	list_for_each(curr, proc_list_head) {
		struct proc_dir_entry *proc_entry;

		elem = list_entry(curr, struct proc_list, list);

		if(!strlen(elem->tag))
			continue;

		if(!(proc_entry =
			create_proc_entry(elem->tag, S_IFREG, parent)))
			return 0;

		proc_entry->read_proc = e1000_proc_single_read;
		proc_entry->data = elem;
		SET_MODULE_OWNER(proc_entry);
	}

	return 1;
}

static void __devinit
e1000_proc_dirs_create(void *data, char *name, 
                       struct list_head *proc_list_head)
{
	struct proc_dir_entry *intel_proc_dir, *proc_dir, *info_entry;
	char info_name[strlen(name) + strlen(".info")];

	for(intel_proc_dir = proc_net->subdir; intel_proc_dir;
		intel_proc_dir = intel_proc_dir->next) {
		if((intel_proc_dir->namelen == strlen(ADAPTERS_PROC_DIR)) &&
		   !memcmp(intel_proc_dir->name, ADAPTERS_PROC_DIR, strlen(ADAPTERS_PROC_DIR)))
			break;
	}

	if(!intel_proc_dir)
		if(!(intel_proc_dir =
			create_proc_entry(ADAPTERS_PROC_DIR,
				S_IFDIR, proc_net)))
			return;

	if(!(proc_dir =
		create_proc_entry(name, S_IFDIR, intel_proc_dir)))
		return;
	SET_MODULE_OWNER(proc_dir);

	if(!e1000_proc_singles_create(proc_dir, proc_list_head))
		return;

	strcpy(info_name, name);
	strcat(info_name, ".info");

	if(!(info_entry =
		create_proc_entry(info_name, S_IFREG, intel_proc_dir)))
		return;
	SET_MODULE_OWNER(info_entry);

	info_entry->read_proc = e1000_proc_info_read;
	info_entry->data = proc_list_head;
}

static void __devinit
e1000_proc_list_add(struct list_head *proc_list_head, char *tag,
                    void *data, size_t len, 
		    char *(*func)(void *, size_t, char *))
{
	struct proc_list *new = (struct proc_list *)
		kmalloc(sizeof(struct proc_list), GFP_KERNEL);

	if(!new)
		return;

	strncpy(new->tag, tag, TAG_MAX_LENGTH);
	new->data = data;
	new->len  = len;
	new->func = func;

	list_add_tail(&new->list, proc_list_head);
}

static void __devexit
e1000_proc_list_free(struct list_head *proc_list_head)
{
	struct proc_list *elem;

	while(!list_empty(proc_list_head)) {
		elem = list_entry(proc_list_head->next, struct proc_list, list);
		list_del(&elem->list);
		kfree(elem);
	}
}

/*
 * General purpose formating functions
 */

static char *
e1000_proc_str(void *data, size_t len, char *buf)
{
	sprintf(buf, "%s", (char *)data);
	return buf;
}

static char *
e1000_proc_hex(void *data, size_t len, char *buf)
{
	switch(len) {
	case sizeof(uint8_t):
		sprintf(buf, "0x%02x", *(uint8_t *)data);
		break;
	case sizeof(uint16_t):
		sprintf(buf, "0x%04x", *(uint16_t *)data);
		break;
	case sizeof(uint32_t):
		sprintf(buf, "0x%08x", *(uint32_t *)data);
		break;
	case sizeof(uint64_t):
		sprintf(buf, "0x%08Lx", (unsigned long long)*(uint64_t *)data);
		break;
	}
	return buf;
}

static char *
e1000_proc_unsigned(void *data, size_t len, char *buf)
{
	switch(len) {
	case sizeof(uint8_t):
		sprintf(buf, "%u", *(uint8_t *)data);
		break;
	case sizeof(uint16_t):
		sprintf(buf, "%u", *(uint16_t *)data);