patch-2.3.15 linux/include/linux/atmdev.h

• Lines: 363
• Date: Tue Aug 24 17:12:23 1999
• Orig file: v2.3.14/linux/include/linux/atmdev.h
• Orig date: Wed Dec 31 16:00:00 1969

diff -u --recursive --new-file v2.3.14/linux/include/linux/atmdev.h linux/include/linux/atmdev.h
@@ -0,0 +1,362 @@
+/* atmdev.h - ATM device driver declarations and various related items */
+ 
+/* Written 1995-1999 by Werner Almesberger, EPFL LRC/ICA */
+ 
+
+#ifndef LINUX_ATMDEV_H
+#define LINUX_ATMDEV_H
+
+
+#include <linux/config.h>
+#include <linux/atmioc.h>
+
+
+#define ESI_LEN		6
+
+#define ATM_OC3_PCR	(155520000/270*260/8/53)
+			/* OC3 link rate:  155520000 bps
+			   SONET overhead: /270*260 (9 section, 1 path)
+			   bits per cell:  /8/53
+			   max cell rate:  353207.547 cells/sec */
+
+#define ATM_PDU_OVHD	0	/* number of bytes to charge against buffer
+				   quota per PDU */
+
+#define ATM_SD(s)	((s)->sk->protinfo.af_atm)
+
+
+struct atm_aal_stats {
+	long		tx,tx_err;	/* TX okay and errors */
+	long		rx,rx_err;	/* RX okay and errors */
+	long		rx_drop;	/* RX out of memory */
+};
+
+
+struct atm_dev_stats {
+	struct atm_aal_stats aal0;
+	struct atm_aal_stats aal34;
+	struct atm_aal_stats aal5;
+};
+
+
+#define ATM_GETLINKRATE	_IOW('a',ATMIOC_ITF+1,struct atmif_sioc)
+					/* get link rate */
+#define ATM_GETNAMES	_IOW('a',ATMIOC_ITF+3,struct atm_iobuf)
+					/* get interface names (numbers) */
+#define ATM_GETTYPE	_IOW('a',ATMIOC_ITF+4,struct atmif_sioc)
+					/* get interface type name */
+#define ATM_GETESI	_IOW('a',ATMIOC_ITF+5,struct atmif_sioc)
+					/* get interface ESI */
+#define ATM_GETADDR	_IOW('a',ATMIOC_ITF+6,struct atmif_sioc)
+					/* get itf's local ATM addr. list */
+#define ATM_RSTADDR	_IOW('a',ATMIOC_ITF+7,struct atmif_sioc)
+					/* reset itf's ATM address list */
+#define ATM_ADDADDR	_IOW('a',ATMIOC_ITF+8,struct atmif_sioc)
+					/* add a local ATM address */
+#define ATM_DELADDR	_IOW('a',ATMIOC_ITF+9,struct atmif_sioc)
+					/* remove a local ATM address */
+#define ATM_GETCIRANGE	_IOW('a',ATMIOC_ITF+10,struct atmif_sioc)
+					/* get connection identifier range */
+#define ATM_SETCIRANGE	_IOW('a',ATMIOC_ITF+11,struct atmif_sioc)
+					/* set connection identifier range */
+#define ATM_SETESI	_IOW('a',ATMIOC_ITF+12,struct atmif_sioc)
+					/* set interface ESI */
+#define ATM_SETESIF	_IOW('a',ATMIOC_ITF+13,struct atmif_sioc)
+					/* force interface ESI */
+#define ATM_GETSTAT	_IOW('a',ATMIOC_SARCOM+0,struct atmif_sioc)
+					/* get AAL layer statistics */
+#define ATM_GETSTATZ	_IOW('a',ATMIOC_SARCOM+1,struct atmif_sioc)
+					/* get AAL layer statistics and zero */
+#define ATM_SETSC	_IOW('a',ATMIOC_SPECIAL+1,int)
+					/* enable or disable single-copy */
+
+/* for ATM_GETTYPE */
+#define ATM_ITFTYP_LEN	8	/* maximum length of interface type name */
+
+
+
+struct atm_iobuf {
+	int length;
+	void *buffer;
+};
+
+/* for ATM_GETCIRANGE / ATM_SETCIRANGE */
+
+#define ATM_CI_MAX      -1              /* use maximum range of VPI/VCI */
+ 
+struct atm_cirange {
+	char	vpi_bits;		/* 1..8, ATM_CI_MAX (-1) for maximum */
+	char	vci_bits;		/* 1..16, ATM_CI_MAX (-1) for maximum */
+};
+
+/* for ATM_SETSC; actually taken from the ATM_VF number space */
+
+#define ATM_SC_RX	1024		/* enable RX single-copy */
+#define ATM_SC_TX	2048		/* enable TX single-copy */
+
+#define ATM_BACKLOG_DEFAULT 32 /* if we get more, we're likely to time out
+				  anyway */
+
+/* MF: change_qos (Modify) flags */
+
+#define ATM_MF_IMMED	 1	/* Block until change is effective */
+#define ATM_MF_INC_RSV	 2	/* Change reservation on increase */
+#define ATM_MF_INC_SHP	 4	/* Change shaping on increase */
+#define ATM_MF_DEC_RSV	 8	/* Change reservation on decrease */
+#define ATM_MF_DEC_SHP	16	/* Change shaping on decrease */
+#define ATM_MF_BWD	32	/* Set the backward direction parameters */
+
+#define ATM_MF_SET	(ATM_MF_INC_RSV | ATM_MF_INC_SHP | ATM_MF_DEC_RSV | \
+			  ATM_MF_DEC_SHP | ATM_MF_BWD)
+
+/*
+ * ATM_VS_* are used to express VC state in a human-friendly way.
+ */
+
+#define ATM_VS_IDLE	0	/* VC is not used */
+#define ATM_VS_CONNECTED 1	/* VC is connected */
+#define ATM_VS_CLOSING	2	/* VC is closing */
+#define ATM_VS_LISTEN	3	/* VC is listening for incoming setups */
+#define ATM_VS_INUSE	4	/* VC is in use (registered with atmsigd) */
+#define ATM_VS_BOUND	5	/* VC is bound */
+
+#define ATM_VS2TXT_MAP \
+    "IDLE", "CONNECTED", "CLOSING", "LISTEN", "INUSE", "BOUND"
+
+
+#ifdef __KERNEL__
+
+#include <linux/sched.h> /* wait_queue_head_t */
+#include <linux/time.h> /* struct timeval */
+#include <linux/net.h>
+#include <linux/skbuff.h> /* struct sk_buff */
+#include <linux/atm.h>
+#include <linux/uio.h>
+#include <asm/atomic.h>
+
+#ifdef CONFIG_PROC_FS
+#include <linux/proc_fs.h>
+#endif
+
+#ifdef CONFIG_AREQUIPA
+#include <net/sock.h> /* for struct sock */
+#endif
+
+
+#define ATM_VF_ADDR	1	/* Address is in use. Set by anybody, cleared
+				   by device driver. */
+#define ATM_VF_READY	2	/* VC is ready to transfer data. Set by device
+				   driver, cleared by anybody. */
+#define ATM_VF_PARTIAL	4	/* resources are bound to PVC (partial PVC
+				   setup), controlled by socket layer */
+#define ATM_VF_BOUND	16384	/* local SAP is set, controlled by SVC socket
+				   layer */
+#define ATM_VF_REGIS	8	/* registered with demon, controlled by SVC
+				   socket layer */
+#define ATM_VF_RELEASED 16	/* demon has indicated/requested release,
+				   controlled by SVC socket layer */
+#define ATM_VF_HASQOS	32	/* QOS parameters have been set */
+#define ATM_VF_LISTEN	64	/* socket is used for listening */
+#define ATM_VF_META	128	/* SVC socket isn't used for normal data
+				   traffic and doesn't depend on signaling
+				   to be available */
+#define ATM_VF_AQREL	256	/* Arequipa VC is being released */
+#define ATM_VF_AQDANG	512	/* VC is in Arequipa's dangling list */
+#define ATM_VF_SCRX	ATM_SC_RX /* 1024; allow single-copy in the RX dir. */
+#define ATM_VF_SCTX	ATM_SC_TX /* 2048; allow single-copy in the TX dir. */
+#define ATM_VF_SESSION	4096	/* VCC is p2mp session control descriptor */
+#define ATM_VF_HASSAP	8192	/* SAP has been set */
+#define ATM_VF_CLOSE	32768	/* asynchronous close - treat like VF_RELEASED*/
+
+#define ATM_VF2VS(flags) \
+    ((flags) & ATM_VF_READY ? ATM_VS_CONNECTED : \
+     (flags) & ATM_VF_RELEASED ? ATM_VS_CLOSING : \
+     (flags) & ATM_VF_LISTEN ? ATM_VS_LISTEN : \
+     (flags) & ATM_VF_REGIS ? ATM_VS_INUSE : \
+     (flags) & ATM_VF_BOUND ? ATM_VS_BOUND : ATM_VS_IDLE)
+
+#define ATM_DF_CLOSE	1	/* close device when last VCC is closed */
+
+#define ATM_PHY_SIG_LOST    0	/* no carrier/light */
+#define ATM_PHY_SIG_UNKNOWN 1	/* carrier/light status is unknown */
+#define ATM_PHY_SIG_FOUND   2	/* carrier/light okay */
+
+#define ATM_ATMOPT_CLP	1	/* set CLP bit */
+
+
+struct atm_vcc {
+	unsigned short	flags;		/* VCC flags (ATM_VF_*) */
+	unsigned char	family;		/* address family; 0 if unused */
+	short		vpi;		/* VPI and VCI (types must be equal */
+					/* with sockaddr) */
+	int 		vci;
+	unsigned long	aal_options;	/* AAL layer options */
+	unsigned long	atm_options;	/* ATM layer options */
+	struct atm_dev	*dev;		/* device back pointer */
+	struct atm_qos	qos;		/* QOS */
+	struct atm_sap	sap;		/* SAP */
+	unsigned long	tx_quota,rx_quota; /* buffer quotas */
+	atomic_t	tx_inuse,rx_inuse; /* buffer space in use */
+	void (*push)(struct atm_vcc *vcc,struct sk_buff *skb);
+	void (*pop)(struct atm_vcc *vcc,struct sk_buff *skb); /* optional */
+	struct sk_buff *(*alloc_tx)(struct atm_vcc *vcc,unsigned int size);
+					/* TX allocation routine - can be */
+					/* modified by protocol or by driver.*/
+					/* NOTE: this interface will change */
+	int (*push_oam)(struct atm_vcc *vcc,void *cell);
+	void		*dev_data;	/* per-device data */
+	void		*proto_data;	/* per-protocol data */
+	struct timeval	timestamp;	/* AAL timestamps */
+	struct sk_buff_head recvq;	/* receive queue */
+	struct atm_aal_stats *stats;	/* pointer to AAL stats group */
+	wait_queue_head_t sleep;	/* if socket is busy */
+	wait_queue_head_t wsleep;	/* if waiting for write buffer space */
+	struct atm_vcc	*prev,*next;
+	/* SVC part --- may move later ------------------------------------- */
+	short		itf;		/* interface number */
+	struct sockaddr_atmsvc local;
+	struct sockaddr_atmsvc remote;
+	void (*callback)(struct atm_vcc *vcc);
+	struct sk_buff_head listenq;
+	int		backlog_quota;	/* number of connection requests we */
+					/* can still accept */
+	int		reply;
+	/* Multipoint part ------------------------------------------------- */
+	struct atm_vcc	*session;	/* session VCC descriptor */
+	/* Other stuff ----------------------------------------------------- */
+	void		*user_back;	/* user backlink - not touched */
+#ifdef CONFIG_AREQUIPA
+	struct sock	*upper;		/* our "master" */
+	struct socket	*sock;		/* back pointer to our own socket */
+	struct atm_vcc	*aq_next,*aq_prev; /* for consistency checks */
+	unsigned long	generation;	/* generation number */
+#endif
+};
+
+
+struct atm_dev_addr {
+	struct sockaddr_atmsvc addr;	/* ATM address */
+	struct atm_dev_addr *next;	/* next address */
+};
+
+
+struct atm_dev {
+	const struct atmdev_ops *ops;	/* device operations; NULL if unused */
+	const struct atmphy_ops *phy;	/* PHY operations, may be undefined */
+					/* (NULL) */
+	const char	*type;		/* device type name */
+	int		number;		/* device index */
+	struct atm_vcc	*vccs;		/* VCC table (or NULL) */
+	struct atm_vcc	*last;		/* last VCC (or undefined) */
+	void		*dev_data;	/* per-device data */
+	void		*phy_data;	/* private PHY date */
+	unsigned long	flags;		/* device flags (ATM_DF_*) */
+	struct atm_dev_addr *local;	/* local ATM addresses */
+	unsigned char	esi[ESI_LEN];	/* ESI ("MAC" addr) */
+	struct atm_cirange ci_range;	/* VPI/VCI range */
+	struct atm_dev_stats stats;	/* statistics */
+	char		signal;		/* signal status (ATM_PHY_SIG_*) */
+	int		link_rate;	/* link rate (default: OC3) */
+#ifdef CONFIG_PROC_FS
+	struct proc_dir_entry *proc_entry; /* proc entry */
+	char *proc_name;		/* proc entry name */
+#endif
+	struct atm_dev	*prev,*next;	/* linkage */
+};
+
+
+/*
+ * ioctl, getsockopt, setsockopt, and sg_send are optional and can be set to
+ * NULL. */
+
+/* OF: send_Oam Flags */
+
+#define ATM_OF_IMMED	1	/* Attempt immediate delivery */
+#define ATM_OF_INRATE	2	/* Attempt in-rate delivery */
+
+struct atmdev_ops { /* only send is required */
+	void (*dev_close)(struct atm_dev *dev);
+	int (*open)(struct atm_vcc *vcc,short vpi,int vci);
+	void (*close)(struct atm_vcc *vcc);
+	int (*ioctl)(struct atm_dev *dev,unsigned int cmd,void *arg);
+	int (*getsockopt)(struct atm_vcc *vcc,int level,int optname,
+	    void *optval,int optlen);
+	int (*setsockopt)(struct atm_vcc *vcc,int level,int optname,
+	    void *optval,int optlen);
+	int (*send)(struct atm_vcc *vcc,struct sk_buff *skb);
+	int (*sg_send)(struct atm_vcc *vcc,unsigned long start,
+	    unsigned long size);
+#if 0 /* keep the current hack for now */
+	int (*send_iovec)(struct atm_vcc *vcc,struct iovec *iov,int size,
+	    void (*discard)(struct atm_vcc *vcc,void *user),void *user);
+#endif
+	int (*send_oam)(struct atm_vcc *vcc,void *cell,int flags);
+	void (*phy_put)(struct atm_dev *dev,unsigned char value,
+	    unsigned long addr);
+	unsigned char (*phy_get)(struct atm_dev *dev,unsigned long addr);
+	void (*feedback)(struct atm_vcc *vcc,struct sk_buff *skb,
+	    unsigned long start,unsigned long dest,int len);
+	int (*change_qos)(struct atm_vcc *vcc,struct atm_qos *qos,int flags);
+	void (*free_rx_skb)(struct atm_vcc *vcc, struct sk_buff *skb);
+		/* @@@ temporary hack */
+	int (*proc_read)(struct atm_dev *dev,loff_t *pos,char *page);
+};
+
+
+struct atmphy_ops {
+	int (*start)(struct atm_dev *dev);
+	int (*ioctl)(struct atm_dev *dev,unsigned int cmd,void *arg);
+	void (*interrupt)(struct atm_dev *dev);
+};
+
+struct atm_skb_data {
+	struct atm_vcc	*vcc;		/* ATM VCC */
+	int		iovcnt;		/* 0 for "normal" operation */
+	unsigned long	atm_options;	/* ATM layer options */
+};
+
+#define ATM_SKB(skb) (((struct atm_skb_data *) (skb)->cb))
+
+struct atm_dev *atm_dev_register(const char *type,const struct atmdev_ops *ops,
+    int number,unsigned long flags); /* number == -1: pick first available */
+struct atm_dev *atm_find_dev(int number);
+void atm_dev_deregister(struct atm_dev *dev);
+void shutdown_atm_dev(struct atm_dev *dev);
+void bind_vcc(struct atm_vcc *vcc,struct atm_dev *dev);
+
+
+/* This is the algorithm used by alloc_skb
+
+   SHIT! It is fully illegal. If we could derive truesize
+   from another skb parameter, we would not create this variable.
+   Do not wonder, if allocating 5K skbm truesize will be > 8K.
+ */
+
+static __inline__ int atm_pdu2truesize(int pdu_size)
+{
+	return ((pdu_size+15) & ~15) + sizeof(struct sk_buff);
+}
+
+
+static __inline__ void atm_force_charge(struct atm_vcc *vcc,int truesize)
+{
+	atomic_add(truesize+ATM_PDU_OVHD,&vcc->rx_inuse);
+}
+
+
+static __inline__ void atm_return(struct atm_vcc *vcc,int truesize)
+{
+	atomic_sub(truesize+ATM_PDU_OVHD,&vcc->rx_inuse);
+}
+
+
+int atm_charge(struct atm_vcc *vcc,int truesize);
+void atm_return(struct atm_vcc *vcc,int truesize);
+int atm_find_ci(struct atm_vcc *vcc,short *vpi,int *vci);
+int atm_pcr_goal(struct atm_trafprm *tp);
+
+void atm_async_release_vcc(struct atm_vcc *vcc,int reply);
+
+#endif /* __KERNEL__ */
+
+#endif