Mercurial > ecos
diff packages/io/eth/current/include/eth_drv.h @ 115:6ed91473a1cd ecos-sw-2000-08-21
Merge from eCos master repository on 2000-08-21-22:40:54-BST
| author | jlarmour |
|---|---|
| date | Fri, 25 Aug 2000 17:32:38 +0000 |
| parents | |
| children | bd1a71e3e476 |
line wrap: on
line diff
new file mode 100644 --- /dev/null +++ b/packages/io/eth/current/include/eth_drv.h @@ -0,0 +1,197 @@ +//========================================================================== +// +// include/eth_drv.h +// +// High level networking driver interfaces +// +//========================================================================== +//####COPYRIGHTBEGIN#### +// +// ------------------------------------------- +// The contents of this file are subject to the Red Hat eCos Public License +// Version 1.1 (the "License"); you may not use this file except in +// compliance with the License. You may obtain a copy of the License at +// http://www.redhat.com/ +// +// Software distributed under the License is distributed on an "AS IS" +// basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the +// License for the specific language governing rights and limitations under +// the License. +// +// The Original Code is eCos - Embedded Configurable Operating System, +// released September 30, 1998. +// +// The Initial Developer of the Original Code is Red Hat. +// Portions created by Red Hat are +// Copyright (C) 1998, 1999, 2000 Red Hat, Inc. +// All Rights Reserved. +// ------------------------------------------- +// +//####COPYRIGHTEND#### +//####BSDCOPYRIGHTBEGIN#### +// +// ------------------------------------------- +// +// Portions of this software may have been derived from OpenBSD or other sources, +// and are covered by the appropriate copyright disclaimers included herein. +// +// ------------------------------------------- +// +//####BSDCOPYRIGHTEND#### +//========================================================================== +//#####DESCRIPTIONBEGIN#### +// +// Author(s): gthomas +// Contributors: gthomas +// Date: 2000-01-10 +// Purpose: +// Description: High level networking driver interfaces +// +// +//####DESCRIPTIONEND#### +// +//========================================================================== + +// Ethernet driver structure + +#ifndef _ETH_DRV_H_ +#define _ETH_DRV_H_ + +#include <pkgconf/system.h> + +#ifdef CYGPKG_NET +#include <sys/param.h> +#include <sys/socket.h> + +#include <net/if.h> + +#ifdef INET +#include <netinet/in.h> +#include <netinet/in_systm.h> +#include <netinet/in_var.h> +#include <netinet/ip.h> +#include <netinet/if_ether.h> +#endif + +#if NBPFILTER > 0 +#include <net/bpf.h> +#include <net/bpfdesc.h> +#endif +#endif + +struct eth_drv_sg { + CYG_ADDRESS buf; + CYG_ADDRWORD len; +}; + +// This is 16 to ensure that an MTU made of mbufs (not clusters) will fit. +// 1600 is more that the MTU of 1500; it must be right. +#define MAX_ETH_DRV_SG 16 + +struct eth_drv_sc; + +struct eth_drv_funs { + // Logical driver - initialization + void (*init)(struct eth_drv_sc *sc, + unsigned char *enaddr); + // Logical driver - incoming packet notifier + void (*recv)(struct eth_drv_sc *sc, + int total_len); + // Logical driver - outgoing packet notifier + void (*tx_done)(struct eth_drv_sc *sc, + CYG_ADDRESS key, + int status); +}; + +struct eth_hwr_funs { + // Initialize hardware (including startup) + void (*start)(struct eth_drv_sc *sc, + unsigned char *enaddr, + int flags); + // Shut down hardware + void (*stop)(struct eth_drv_sc *sc); + // Device control (ioctl pass-thru) + int (*control)(struct eth_drv_sc *sc, + unsigned long key, + void *data, + int data_length); + // Query - can a packet be sent? + int (*can_send)(struct eth_drv_sc *sc); + // Send a packet of data + void (*send)(struct eth_drv_sc *sc, + struct eth_drv_sg *sg_list, + int sg_len, + int total_len, + unsigned long key); + // Receive [unload] a packet of data + void (*recv)(struct eth_drv_sc *sc, + struct eth_drv_sg *sg_list, + int sg_len); + // Poll for interrupts/device service + void (*poll)(struct eth_drv_sc *sc); + // Logical driver interface + struct eth_drv_funs *eth_drv, *eth_drv_old; +}; + +#ifndef CYGPKG_NET +struct arpcom { + unsigned char esa[6]; +}; +#endif + +struct eth_drv_sc { + struct eth_hwr_funs *funs; + void *driver_private; + const char *dev_name; + int state; + struct arpcom sc_arpcom; /* ethernet common */ +}; + +#define ETH_DRV_SC(sc,priv,name,start,stop,control,can_send,send,recv,poll) \ +static void start(struct eth_drv_sc *sc, unsigned char *enaddr, int flags); \ +static void stop(struct eth_drv_sc *sc); \ +static int control(struct eth_drv_sc *sc, unsigned long key, void *data, int data_length); \ +static int can_send(struct eth_drv_sc *sc); \ +static void send(struct eth_drv_sc *sc, struct eth_drv_sg *sg_list, int sg_len, int total, unsigned long key); \ +static void recv(struct eth_drv_sc *sc, struct eth_drv_sg *sg_list, int sg_len); \ +static void poll(struct eth_drv_sc *sc); \ +static struct eth_hwr_funs sc##_funs = { \ + start, \ + stop, \ + control, \ + can_send, \ + send, \ + recv, \ + poll, \ + ð_drv_funs, \ + (struct eth_drv_funs *)0 }; \ +struct eth_drv_sc sc = {&sc##_funs, priv, name}; + +#define ETH_DRV_STATE_ACTIVE 0x0001 +#define ETH_DRV_STATE_DEBUG 0x1000 + +extern struct eth_drv_funs eth_drv_funs; + +#ifdef CYGPKG_IO_PCMCIA +#ifdef CYGPKG_NET +#include <netdev.h> +cyg_netdevtab_entry_t *eth_drv_netdev(char *name); +#endif +#endif // CYGPKG_IO_PCMCIA + +// Control 'key's +#define ETH_DRV_SET_MAC_ADDRESS 0x0100 + +#ifndef ETHER_ADDR_LEN +#define ETHER_ADDR_LEN 6 +#endif + +#ifndef CYGPKG_NET +extern void eth_drv_buffers_init(void); +extern int eth_drv_read(char *eth_hdr, char *buf, int len); +extern void eth_drv_write(char *eth_hdr, char *buf, int len); +extern unsigned char __local_enet_addr[]; +extern struct eth_drv_sc *__local_enet_sc; +#endif + +#endif // _ETH_DRV_H_
