[mirror_ubuntu-zesty-kernel.git] / include / net / iucv / af_iucv.h

/*
 * Copyright 2006 IBM Corporation
 * IUCV protocol stack for Linux on zSeries
 * Version 1.0
 * Author(s): Jennifer Hunt <jenhunt@us.ibm.com>
 *
 */

#ifndef __AFIUCV_H
#define __AFIUCV_H

#include <asm/types.h>
#include <asm/byteorder.h>
#include <linux/list.h>
#include <linux/poll.h>
#include <linux/socket.h>
#include <net/iucv/iucv.h>

#ifndef AF_IUCV
#define AF_IUCV		32
#define PF_IUCV		AF_IUCV
#endif

/* Connection and socket states */
enum {
	IUCV_CONNECTED = 1,
	IUCV_OPEN,
	IUCV_BOUND,
	IUCV_LISTEN,
	IUCV_SEVERED,
	IUCV_DISCONN,
	IUCV_CLOSING,
	IUCV_CLOSED
};

#define IUCV_QUEUELEN_DEFAULT	65535
#define IUCV_HIPER_MSGLIM_DEFAULT	128
#define IUCV_CONN_TIMEOUT	(HZ * 40)
#define IUCV_DISCONN_TIMEOUT	(HZ * 2)
#define IUCV_CONN_IDLE_TIMEOUT	(HZ * 60)
#define IUCV_BUFSIZE_DEFAULT	32768

/* IUCV socket address */
struct sockaddr_iucv {
	sa_family_t	siucv_family;
	unsigned short	siucv_port;		/* Reserved */
	unsigned int	siucv_addr;		/* Reserved */
	char		siucv_nodeid[8];	/* Reserved */
	char		siucv_user_id[8];	/* Guest User Id */
	char		siucv_name[8];		/* Application Name */
};


/* Common socket structures and functions */
struct sock_msg_q {
	struct iucv_path	*path;
	struct iucv_message	msg;
	struct list_head	list;
	spinlock_t		lock;
};

#define AF_IUCV_FLAG_ACK 0x1
#define AF_IUCV_FLAG_SYN 0x2
#define AF_IUCV_FLAG_FIN 0x4
#define AF_IUCV_FLAG_WIN 0x8

struct af_iucv_trans_hdr {
	u16 magic;
	u8 version;
	u8 flags;
	u16 window;
	char destNodeID[8];
	char destUserID[8];
	char destAppName[16];
	char srcNodeID[8];
	char srcUserID[8];
	char srcAppName[16];             /* => 70 bytes */
	struct iucv_message iucv_hdr;    /* => 33 bytes */
	u8 pad;                          /* total 104 bytes */
} __packed;

enum iucv_tx_notify {
	/* transmission of skb is completed and was successful */
	TX_NOTIFY_OK = 0,
	/* target is unreachable */
	TX_NOTIFY_UNREACHABLE = 1,
	/* transfer pending queue full */
	TX_NOTIFY_TPQFULL = 2,
	/* general error */
	TX_NOTIFY_GENERALERROR = 3,
	/* transmission of skb is pending - may interleave
	 * with TX_NOTIFY_DELAYED_* */
	TX_NOTIFY_PENDING = 4,
	/* transmission of skb was done successfully (delayed) */
	TX_NOTIFY_DELAYED_OK = 5,
	/* target unreachable (detected delayed) */
	TX_NOTIFY_DELAYED_UNREACHABLE = 6,
	/* general error (detected delayed) */
	TX_NOTIFY_DELAYED_GENERALERROR = 7,
};

#define iucv_sk(__sk) ((struct iucv_sock *) __sk)

#define AF_IUCV_TRANS_IUCV 0
#define AF_IUCV_TRANS_HIPER 1

struct iucv_sock {
	struct sock		sk;
	char			src_user_id[8];
	char			src_name[8];
	char			dst_user_id[8];
	char			dst_name[8];
	struct list_head	accept_q;
	spinlock_t		accept_q_lock;
	struct sock		*parent;
	struct iucv_path	*path;
	struct sk_buff_head	send_skb_q;
	struct sk_buff_head	backlog_skb_q;
	struct sock_msg_q	message_q;
	unsigned int		send_tag;
	u8			flags;
	u16			msglimit;
	u16			msglimit_peer;
	atomic_t		msg_sent;
	atomic_t		msg_recv;
	atomic_t		pendings;
	int			transport;
	void                    (*sk_txnotify)(struct sk_buff *skb,
					       enum iucv_tx_notify n);
};

/* iucv socket options (SOL_IUCV) */
#define SO_IPRMDATA_MSG	0x0080		/* send/recv IPRM_DATA msgs */
#define SO_MSGLIMIT	0x1000		/* get/set IUCV MSGLIMIT */

/* iucv related control messages (scm) */
#define SCM_IUCV_TRGCLS	0x0001		/* target class control message */

struct iucv_sock_list {
	struct hlist_head head;
	rwlock_t	  lock;
	atomic_t	  autobind_name;
};

unsigned int iucv_sock_poll(struct file *file, struct socket *sock,
			    poll_table *wait);
void iucv_sock_link(struct iucv_sock_list *l, struct sock *s);
void iucv_sock_unlink(struct iucv_sock_list *l, struct sock *s);
int  iucv_sock_wait_cnt(struct sock *sk, unsigned long timeo);
void iucv_accept_enqueue(struct sock *parent, struct sock *sk);
void iucv_accept_unlink(struct sock *sk);
struct sock *iucv_accept_dequeue(struct sock *parent, struct socket *newsock);

#endif /* __IUCV_H */
Commit	Line	Data
eac3731b JH	1	/*
	2	* Copyright 2006 IBM Corporation
	3	* IUCV protocol stack for Linux on zSeries
	4	* Version 1.0
	5	* Author(s): Jennifer Hunt <jenhunt@us.ibm.com>
	6	*
	7	*/
	8
	9	#ifndef __AFIUCV_H
	10	#define __AFIUCV_H
	11
	12	#include <asm/types.h>
	13	#include <asm/byteorder.h>
	14	#include <linux/list.h>
	15	#include <linux/poll.h>
	16	#include <linux/socket.h>
3881ac44	17	#include <net/iucv/iucv.h>
eac3731b JH	18
	19	#ifndef AF_IUCV
	20	#define AF_IUCV 32
	21	#define PF_IUCV AF_IUCV
	22	#endif
	23
	24	/* Connection and socket states */
	25	enum {
	26	IUCV_CONNECTED = 1,
	27	IUCV_OPEN,
	28	IUCV_BOUND,
	29	IUCV_LISTEN,
	30	IUCV_SEVERED,
	31	IUCV_DISCONN,
561e0360	32	IUCV_CLOSING,
eac3731b JH	33	IUCV_CLOSED
	34	};
	35
	36	#define IUCV_QUEUELEN_DEFAULT 65535
3881ac44	37	#define IUCV_HIPER_MSGLIM_DEFAULT 128
eac3731b JH	38	#define IUCV_CONN_TIMEOUT (HZ * 40)
	39	#define IUCV_DISCONN_TIMEOUT (HZ * 2)
	40	#define IUCV_CONN_IDLE_TIMEOUT (HZ * 60)
	41	#define IUCV_BUFSIZE_DEFAULT 32768
	42
	43	/* IUCV socket address */
	44	struct sockaddr_iucv {
	45	sa_family_t siucv_family;
	46	unsigned short siucv_port; /* Reserved */
	47	unsigned int siucv_addr; /* Reserved */
	48	char siucv_nodeid[8]; /* Reserved */
	49	char siucv_user_id[8]; /* Guest User Id */
	50	char siucv_name[8]; /* Application Name */
	51	};
	52
	53
	54	/* Common socket structures and functions */
f0703c80 UB	55	struct sock_msg_q {
	56	struct iucv_path *path;
	57	struct iucv_message msg;
	58	struct list_head list;
	59	spinlock_t lock;
	60	};
eac3731b	61
3881ac44 UB	62	#define AF_IUCV_FLAG_ACK 0x1
	63	#define AF_IUCV_FLAG_SYN 0x2
	64	#define AF_IUCV_FLAG_FIN 0x4
	65	#define AF_IUCV_FLAG_WIN 0x8
	66
	67	struct af_iucv_trans_hdr {
	68	u16 magic;
	69	u8 version;
	70	u8 flags;
	71	u16 window;
	72	char destNodeID[8];
	73	char destUserID[8];
	74	char destAppName[16];
	75	char srcNodeID[8];
	76	char srcUserID[8];
	77	char srcAppName[16]; /* => 70 bytes */
	78	struct iucv_message iucv_hdr; /* => 33 bytes */
	79	u8 pad; /* total 104 bytes */
	80	} __packed;
	81
	82	enum iucv_tx_notify {
	83	/* transmission of skb is completed and was successful */
	84	TX_NOTIFY_OK = 0,
	85	/* target is unreachable */
	86	TX_NOTIFY_UNREACHABLE = 1,
	87	/* transfer pending queue full */
	88	TX_NOTIFY_TPQFULL = 2,
	89	/* general error */
	90	TX_NOTIFY_GENERALERROR = 3,
	91	/* transmission of skb is pending - may interleave
	92	* with TX_NOTIFY_DELAYED_* */
	93	TX_NOTIFY_PENDING = 4,
	94	/* transmission of skb was done successfully (delayed) */
	95	TX_NOTIFY_DELAYED_OK = 5,
	96	/* target unreachable (detected delayed) */
	97	TX_NOTIFY_DELAYED_UNREACHABLE = 6,
	98	/* general error (detected delayed) */
	99	TX_NOTIFY_DELAYED_GENERALERROR = 7,
	100	};
	101
eac3731b JH	102	#define iucv_sk(__sk) ((struct iucv_sock *) __sk)
eac3731b JH	103
3881ac44 UB	104	#define AF_IUCV_TRANS_IUCV 0
	105	#define AF_IUCV_TRANS_HIPER 1
	106
eac3731b JH	107	struct iucv_sock {
	108	struct sock sk;
	109	char src_user_id[8];
	110	char src_name[8];
	111	char dst_user_id[8];
	112	char dst_name[8];
	113	struct list_head accept_q;
febca281	114	spinlock_t accept_q_lock;
eac3731b JH	115	struct sock *parent;
	116	struct iucv_path *path;
	117	struct sk_buff_head send_skb_q;
561e0360	118	struct sk_buff_head backlog_skb_q;
f0703c80	119	struct sock_msg_q message_q;
eac3731b	120	unsigned int send_tag;
9d5c5d8f	121	u8 flags;
09488e2e	122	u16 msglimit;
3881ac44 UB	123	u16 msglimit_peer;
	124	atomic_t msg_sent;
	125	atomic_t msg_recv;
	126	atomic_t pendings;
	127	int transport;
	128	void (sk_txnotify)(struct sk_buff skb,
	129	enum iucv_tx_notify n);
eac3731b JH	130	};
eac3731b JH	131
9d5c5d8f HB	132	/* iucv socket options (SOL_IUCV) */
9d5c5d8f HB	133	#define SO_IPRMDATA_MSG 0x0080 /* send/recv IPRM_DATA msgs */
09488e2e	134	#define SO_MSGLIMIT 0x1000 /* get/set IUCV MSGLIMIT */
9d5c5d8f	135
44b1e6b5 HB	136	/* iucv related control messages (scm) */
	137	#define SCM_IUCV_TRGCLS 0x0001 /* target class control message */
	138
eac3731b JH	139	struct iucv_sock_list {
	140	struct hlist_head head;
	141	rwlock_t lock;
	142	atomic_t autobind_name;
	143	};
	144
eac3731b JH	145	unsigned int iucv_sock_poll(struct file file, struct socket sock,
eac3731b JH	146	poll_table *wait);
eac3731b JH	147	void iucv_sock_link(struct iucv_sock_list l, struct sock s);
eac3731b JH	148	void iucv_sock_unlink(struct iucv_sock_list l, struct sock s);
eac3731b JH	149	int iucv_sock_wait_cnt(struct sock *sk, unsigned long timeo);
	150	void iucv_accept_enqueue(struct sock parent, struct sock sk);
	151	void iucv_accept_unlink(struct sock *sk);
	152	struct sock iucv_accept_dequeue(struct sock parent, struct socket *newsock);
	153
	154	#endif /* __IUCV_H */