[mirror_spl.git] / include / sys / sunddi.h

/*
 *  This file is part of the SPL: Solaris Porting Layer.
 *
 *  Copyright (c) 2008 Lawrence Livermore National Security, LLC.
 *  Produced at Lawrence Livermore National Laboratory
 *  Written by:
 *          Brian Behlendorf <behlendorf1@llnl.gov>,
 *          Herb Wartens <wartens2@llnl.gov>,
 *          Jim Garlick <garlick@llnl.gov>
 *  UCRL-CODE-235197
 *
 *  This is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 *  for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 */

#ifndef _SPL_SUNDDI_H
#define _SPL_SUNDDI_H

#include <sys/cred.h>
#include <sys/uio.h>
#include <sys/sunldi.h>
#include <sys/mutex.h>
#include <linux/kdev_t.h>
#include <linux/fs.h>
#include <linux/cdev.h>
#include <linux/list.h>
#include <spl-device.h>

typedef int ddi_devid_t;

typedef enum {
	DDI_INFO_DEVT2DEVINFO	= 0,
	DDI_INFO_DEVT2INSTANCE	= 1
} ddi_info_cmd_t;

typedef enum {
	DDI_ATTACH		= 0,
	DDI_RESUME		= 1,
	DDI_PM_RESUME		= 2
} ddi_attach_cmd_t;

typedef enum {
	DDI_DETACH		= 0,
	DDI_SUSPEND		= 1,
	DDI_PM_SUSPEND		= 2,
	DDI_HOTPLUG_DETACH	= 3
} ddi_detach_cmd_t;

typedef enum {
	DDI_RESET_FORCE = 0
} ddi_reset_cmd_t;

typedef enum {
	PROP_LEN		= 0,
	PROP_LEN_AND_VAL_BUF	= 1,
	PROP_LEN_AND_VAL_ALLOC	= 2,
	PROP_EXISTS		= 3
} ddi_prop_op_t;

typedef void *devmap_cookie_t;
typedef struct as {
       uchar_t  a_flags;
} as_t;

typedef struct pollhead {
	struct polldat *ph_list;
} pollhead_t;

typedef struct dev_info {
	kmutex_t di_lock;
	struct dev_ops *di_ops;
	struct cdev *di_cdev;
	spl_class *di_class;
	spl_device *di_device;
	major_t	di_major;
	minor_t di_minor;
	dev_t di_dev;
	unsigned di_minors;
	int di_flags;
	struct list_head di_list;
} dev_info_t;

typedef struct cb_ops {
	int (*cb_open)(dev_t *devp, int flag, int otyp, cred_t *credp);
	int (*cb_close)(dev_t dev, int flag, int otyp, cred_t *credp);
	int (*cb_strategy)(void *bp);
	int (*cb_print)(dev_t dev, char *str);
	int (*cb_dump)(dev_t dev, caddr_t addr, daddr_t blkno, int nblk);
	int (*cb_read)(dev_t dev, struct uio *uiop, cred_t *credp);
	int (*cb_write)(dev_t dev, struct uio *uiop, cred_t *credp);
	int (*cb_ioctl)(dev_t dev, int cmd, intptr_t arg, int mode,
	                cred_t *credp, int *rvalp);
	int (*cb_devmap)(dev_t dev, devmap_cookie_t dhp, offset_t off,
	                 size_t len, size_t *maplen, uint_t model);
	int (*cb_mmap)(dev_t dev, off_t off, int prot);
	int (*cb_segmap)(dev_t dev, off_t off, struct as *asp,
	                 caddr_t *addrp, off_t len, unsigned int prot,
	                 unsigned int maxprot, unsigned int flags,
	                 cred_t *credp);
	int (*cb_chpoll)(dev_t dev, short events, int anyyet,
	                 short *reventsp, struct pollhead **phpp);
	int (*cb_prop_op)(dev_t dev, dev_info_t *dip,
	                  ddi_prop_op_t prop_op, int mod_flags,
	                  char *name, caddr_t valuep, int *length);
	struct streamtab *cb_str;
	int cb_flag;
	int cb_rev;
	int (*cb_aread)(dev_t dev, struct aio_req *aio, cred_t *credp);
	int (*cb_awrite)(dev_t dev, struct aio_req *aio, cred_t *credp);
} cb_ops_t;

typedef struct dev_ops {
	int devo_rev;
	int devo_refcnt;

	int (*devo_getinfo)(dev_info_t *dip,
	                    ddi_info_cmd_t infocmd, void *arg, void **result);
	int (*devo_identify)(dev_info_t *dip);
	int (*devo_probe)(dev_info_t *dip);
	int (*devo_attach)(dev_info_t *dip, ddi_attach_cmd_t cmd);
	int (*devo_detach)(dev_info_t *dip, ddi_detach_cmd_t cmd);
	int (*devo_reset)(dev_info_t *dip, ddi_reset_cmd_t cmd);

	struct cb_ops *devo_cb_ops;
	struct bus_ops *devo_bus_ops;
	int (*devo_power)(dev_info_t *dip, int component, int level);
} dev_ops_t;

typedef struct mod_ops {
	int (*modm_install)(void);
	int (*modm_remove)(void);
	int (*modm_info)(void);
} mod_ops_t;

typedef struct modldrv {
	struct mod_ops *drv_modops;
	char *drv_linkinfo;
	struct dev_ops *drv_dev_ops;
	struct dev_info *drv_dev_info;
} modldrv_t;

#define	MODREV_1			1

#define	D_NEW				0x000
#define D_MP				0x020
#define	D_64BIT				0x200

#define	DEVO_REV			3
#define	CB_REV				1

#define	DDI_SUCCESS			0
#define	DDI_FAILURE			-1

#define	DDI_PSEUDO			"ddi_pseudo"

#define nodev				NULL
#define nochpoll			NULL
#define nulldev				NULL
#define mod_driverops			NULL
#define ddi_prop_op			NULL

#define getminor(x)			(x)
#define getmajor(x)			(x)
#define ddi_driver_major(di)		getmajor(di->di_dev)

#define	DDI_DEV_T_NONE			((dev_t)-1)
#define	DDI_DEV_T_ANY			((dev_t)-2)
#define	DDI_MAJOR_T_UNKNOWN		((major_t)0)

#define	DDI_PROP_DONTPASS		0x0001
#define	DDI_PROP_CANSLEEP		0x0002

#define	GLOBAL_DEV			0x02
#define	NODEBOUND_DEV			0x04
#define	NODESPECIFIC_DEV		0x06
#define	ENUMERATED_DEV			0x08

#define ddi_prop_lookup_string(x1,x2,x3,x4,x5)	(*x5 = NULL)
#define ddi_prop_free(x)			(void)0
#define ddi_root_node()				(void)0

#define mod_install(x)			0
#define mod_remove(x)			0

extern int __ddi_create_minor_node(dev_info_t *dip, char *name, int spec_type,
                                   minor_t minor_num, char *node_type,
				   int flags, struct module *mod);
extern void __ddi_remove_minor_node(dev_info_t *dip, char *name);
extern int __mod_install(struct modlinkage *modlp);
extern int __mod_remove(struct modlinkage *modlp);

static __inline__ void ddi_report_dev(dev_info_t *d) { }
static __inline__ void ddi_prop_remove_all(dev_info_t *dip) { }

static __inline__ void
ddi_remove_minor_node(dev_info_t *di, char *name)
{
#ifdef HAVE_GPL_ONLY_SYMBOLS
	/* Cleanup udev (GPL-only symbols required).  This is performed as
	 * part of an inline function to ensure that these symbols are not
	 * linked against the SPL which is GPL'ed.  But instead they are
	 * linked against the package building against the SPL to ensure
	 * its license allows linking with GPL-only symbols. */
	if (di->di_class) {
		spl_device_destroy(di->di_class, di->di_device, di->di_dev);
		spl_class_destroy(di->di_class);
		di->di_class = NULL;
		di->di_dev = 0;
	}
#endif

	__ddi_remove_minor_node(di, name);
}

static __inline__ int
ddi_create_minor_node(dev_info_t *di, char *name, int spec_type,
                      minor_t minor_num, char *node_type, int flags)
{
	int rc;

	rc = __ddi_create_minor_node(di, name, spec_type, minor_num,
	                             node_type, flags, THIS_MODULE);
	if (rc)
		return rc;

#ifdef HAVE_GPL_ONLY_SYMBOLS
	/* Setup udev (GPL-only symbols required).  This is performed as
	 * part of an inline function to ensure that these symbols are not
	 * linked against the SPL which is GPL'ed.  But instead they are
	 * linked against the package building against the SPL to ensure
	 * its license allows linking with GPL-only symbols. */
	di->di_class = spl_class_create(THIS_MODULE, name);
	if (IS_ERR(di->di_class)) {
		rc = PTR_ERR(di->di_class);
		di->di_class = NULL;
		ddi_remove_minor_node(di, name);
		CERROR("Error creating %s class, %d\n", name, rc);
		RETURN(DDI_FAILURE);
	}

	/* Do not append a 0 to devices with minor nums of 0 */
	di->di_device = spl_device_create(di->di_class, NULL, di->di_dev, NULL,
					  (di->di_minor == 0) ? "%s" : "%s%d",
					  name, di->di_minor);
#endif

	return rc;
}

#undef mod_install
#undef mod_remove

#define mod_install			__mod_install
#define mod_remove			__mod_remove

#endif /* SPL_SUNDDI_H */
Commit	Line	Data
715f6251	1	/*
	2	* This file is part of the SPL: Solaris Porting Layer.
	3	*
	4	* Copyright (c) 2008 Lawrence Livermore National Security, LLC.
	5	* Produced at Lawrence Livermore National Laboratory
	6	* Written by:
	7	* Brian Behlendorf <behlendorf1@llnl.gov>,
	8	* Herb Wartens <wartens2@llnl.gov>,
	9	* Jim Garlick <garlick@llnl.gov>
	10	* UCRL-CODE-235197
	11	*
	12	* This is free software; you can redistribute it and/or modify it
	13	* under the terms of the GNU General Public License as published by
	14	* the Free Software Foundation; either version 2 of the License, or
	15	* (at your option) any later version.
	16	*
	17	* This is distributed in the hope that it will be useful, but WITHOUT
	18	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	19	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	20	* for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License along
	23	* with this program; if not, write to the Free Software Foundation, Inc.,
	24	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	25	*/
	26
23f28c4f	27	#ifndef _SPL_SUNDDI_H
	28	#define _SPL_SUNDDI_H
	29
4e62fd41	30	#include <sys/cred.h>
	31	#include <sys/uio.h>
	32	#include <sys/sunldi.h>
	33	#include <sys/mutex.h>
	34	#include <linux/kdev_t.h>
	35	#include <linux/fs.h>
	36	#include <linux/cdev.h>
	37	#include <linux/list.h>
46c685d0	38	#include <spl-device.h>
4e62fd41	39
	40	typedef int ddi_devid_t;
	41
	42	typedef enum {
	43	DDI_INFO_DEVT2DEVINFO = 0,
	44	DDI_INFO_DEVT2INSTANCE = 1
	45	} ddi_info_cmd_t;
	46
	47	typedef enum {
	48	DDI_ATTACH = 0,
	49	DDI_RESUME = 1,
	50	DDI_PM_RESUME = 2
	51	} ddi_attach_cmd_t;
	52
	53	typedef enum {
	54	DDI_DETACH = 0,
	55	DDI_SUSPEND = 1,
	56	DDI_PM_SUSPEND = 2,
	57	DDI_HOTPLUG_DETACH = 3
	58	} ddi_detach_cmd_t;
	59
	60	typedef enum {
	61	DDI_RESET_FORCE = 0
	62	} ddi_reset_cmd_t;
	63
	64	typedef enum {
	65	PROP_LEN = 0,
	66	PROP_LEN_AND_VAL_BUF = 1,
	67	PROP_LEN_AND_VAL_ALLOC = 2,
	68	PROP_EXISTS = 3
	69	} ddi_prop_op_t;
	70
	71	typedef void *devmap_cookie_t;
	72	typedef struct as {
	73	uchar_t a_flags;
	74	} as_t;
	75
	76	typedef struct pollhead {
	77	struct polldat *ph_list;
	78	} pollhead_t;
	79
	80	typedef struct dev_info {
	81	kmutex_t di_lock;
	82	struct dev_ops *di_ops;
	83	struct cdev *di_cdev;
46c685d0	84	spl_class *di_class;
25557fd8	85	spl_device *di_device;
4e62fd41	86	major_t di_major;
	87	minor_t di_minor;
	88	dev_t di_dev;
	89	unsigned di_minors;
6a1c3d41	90	int di_flags;
4e62fd41	91	struct list_head di_list;
	92	} dev_info_t;
	93
	94	typedef struct cb_ops {
	95	int (cb_open)(dev_t devp, int flag, int otyp, cred_t *credp);
	96	int (cb_close)(dev_t dev, int flag, int otyp, cred_t credp);
	97	int (cb_strategy)(void bp);
	98	int (cb_print)(dev_t dev, char str);
	99	int (*cb_dump)(dev_t dev, caddr_t addr, daddr_t blkno, int nblk);
	100	int (cb_read)(dev_t dev, struct uio uiop, cred_t *credp);
	101	int (cb_write)(dev_t dev, struct uio uiop, cred_t *credp);
	102	int (*cb_ioctl)(dev_t dev, int cmd, intptr_t arg, int mode,
	103	cred_t credp, int rvalp);
	104	int (*cb_devmap)(dev_t dev, devmap_cookie_t dhp, offset_t off,
	105	size_t len, size_t *maplen, uint_t model);
	106	int (*cb_mmap)(dev_t dev, off_t off, int prot);
	107	int (cb_segmap)(dev_t dev, off_t off, struct as asp,
	108	caddr_t *addrp, off_t len, unsigned int prot,
	109	unsigned int maxprot, unsigned int flags,
	110	cred_t *credp);
	111	int (*cb_chpoll)(dev_t dev, short events, int anyyet,
	112	short reventsp, struct pollhead *phpp);
	113	int (cb_prop_op)(dev_t dev, dev_info_t dip,
	114	ddi_prop_op_t prop_op, int mod_flags,
	115	char name, caddr_t valuep, int length);
	116	struct streamtab *cb_str;
	117	int cb_flag;
	118	int cb_rev;
	119	int (cb_aread)(dev_t dev, struct aio_req aio, cred_t *credp);
	120	int (cb_awrite)(dev_t dev, struct aio_req aio, cred_t *credp);
	121	} cb_ops_t;
	122
	123	typedef struct dev_ops {
	124	int devo_rev;
	125	int devo_refcnt;
	126
	127	int (devo_getinfo)(dev_info_t dip,
	128	ddi_info_cmd_t infocmd, void arg, void *result);
	129	int (devo_identify)(dev_info_t dip);
	130	int (devo_probe)(dev_info_t dip);
	131	int (devo_attach)(dev_info_t dip, ddi_attach_cmd_t cmd);
	132	int (devo_detach)(dev_info_t dip, ddi_detach_cmd_t cmd);
	133	int (devo_reset)(dev_info_t dip, ddi_reset_cmd_t cmd);
	134
	135	struct cb_ops *devo_cb_ops;
	136	struct bus_ops *devo_bus_ops;
	137	int (devo_power)(dev_info_t dip, int component, int level);
	138	} dev_ops_t;
	139
	140	typedef struct mod_ops {
	141	int (*modm_install)(void);
	142	int (*modm_remove)(void);
	143	int (*modm_info)(void);
	144	} mod_ops_t;
	145
	146	typedef struct modldrv {
	147	struct mod_ops *drv_modops;
	148	char *drv_linkinfo;
	149	struct dev_ops *drv_dev_ops;
	150	struct dev_info *drv_dev_info;
	151	} modldrv_t;
	152
	153	#define MODREV_1 1
	154
155	#define D_NEW 0x000
156	#define D_MP 0x020
157	#define D_64BIT 0x200
158
159	#define DEVO_REV 3
160	#define CB_REV 1
161
162	#define DDI_SUCCESS 0
163	#define DDI_FAILURE -1
164
165	#define DDI_PSEUDO "ddi_pseudo"
166
167	#define nodev NULL
168	#define nochpoll NULL
169	#define nulldev NULL
170	#define mod_driverops NULL
171	#define ddi_prop_op NULL
172
b831734a	173	#define getminor(x) (x)
	174	#define getmajor(x) (x)
	175	#define ddi_driver_major(di) getmajor(di->di_dev)
4e62fd41	176
6ab69573	177	#define DDI_DEV_T_NONE ((dev_t)-1)
	178	#define DDI_DEV_T_ANY ((dev_t)-2)
	179	#define DDI_MAJOR_T_UNKNOWN ((major_t)0)
	180
	181	#define DDI_PROP_DONTPASS 0x0001
	182	#define DDI_PROP_CANSLEEP 0x0002
	183
6a1c3d41	184	#define GLOBAL_DEV 0x02
	185	#define NODEBOUND_DEV 0x04
	186	#define NODESPECIFIC_DEV 0x06
	187	#define ENUMERATED_DEV 0x08
	188
6ab69573	189	#define ddi_prop_lookup_string(x1,x2,x3,x4,x5) (*x5 = NULL)
	190	#define ddi_prop_free(x) (void)0
	191	#define ddi_root_node() (void)0
	192
4e62fd41	193	#define mod_install(x) 0
	194	#define mod_remove(x) 0
	195
	196	extern int __ddi_create_minor_node(dev_info_t dip, char name, int spec_type,
	197	minor_t minor_num, char *node_type,
6a1c3d41	198	int flags, struct module *mod);
4e62fd41	199	extern void __ddi_remove_minor_node(dev_info_t dip, char name);
	200	extern int __mod_install(struct modlinkage *modlp);
	201	extern int __mod_remove(struct modlinkage *modlp);
	202
	203	static __inline__ void ddi_report_dev(dev_info_t *d) { }
	204	static __inline__ void ddi_prop_remove_all(dev_info_t *dip) { }
	205
6a1c3d41	206	static __inline__ void
	207	ddi_remove_minor_node(dev_info_t di, char name)
	208	{
	209	#ifdef HAVE_GPL_ONLY_SYMBOLS
	210	/* Cleanup udev (GPL-only symbols required). This is performed as
	211	* part of an inline function to ensure that these symbols are not
	212	* linked against the SPL which is GPL'ed. But instead they are
	213	* linked against the package building against the SPL to ensure
	214	* its license allows linking with GPL-only symbols. */
	215	if (di->di_class) {
	216	spl_device_destroy(di->di_class, di->di_device, di->di_dev);
	217	spl_class_destroy(di->di_class);
	218	di->di_class = NULL;
	219	di->di_dev = 0;
	220	}
	221	#endif
	222
	223	__ddi_remove_minor_node(di, name);
	224	}
	225
4e62fd41	226	static __inline__ int
4e62fd41	227	ddi_create_minor_node(dev_info_t di, char name, int spec_type,
6a1c3d41	228	minor_t minor_num, char *node_type, int flags)
4e62fd41	229	{
6a1c3d41	230	int rc;
	231
	232	rc = __ddi_create_minor_node(di, name, spec_type, minor_num,
	233	node_type, flags, THIS_MODULE);
	234	if (rc)
	235	return rc;
	236
	237	#ifdef HAVE_GPL_ONLY_SYMBOLS
	238	/* Setup udev (GPL-only symbols required). This is performed as
	239	* part of an inline function to ensure that these symbols are not
	240	* linked against the SPL which is GPL'ed. But instead they are
	241	* linked against the package building against the SPL to ensure
	242	* its license allows linking with GPL-only symbols. */
	243	di->di_class = spl_class_create(THIS_MODULE, name);
	244	if (IS_ERR(di->di_class)) {
	245	rc = PTR_ERR(di->di_class);
	246	di->di_class = NULL;
	247	ddi_remove_minor_node(di, name);
	248	CERROR("Error creating %s class, %d\n", name, rc);
	249	RETURN(DDI_FAILURE);
	250	}
	251
	252	/* Do not append a 0 to devices with minor nums of 0 */
	253	di->di_device = spl_device_create(di->di_class, NULL, di->di_dev, NULL,
	254	(di->di_minor == 0) ? "%s" : "%s%d",
	255	name, di->di_minor);
	256	#endif
	257
	258	return rc;
4e62fd41	259	}
	260
	261	#undef mod_install
	262	#undef mod_remove
	263
4e62fd41	264	#define mod_install __mod_install
	265	#define mod_remove __mod_remove
	266
23f28c4f	267	#endif /* SPL_SUNDDI_H */