xref: /titanic_51/usr/src/uts/common/sys/dacf.h (revision d62bc4badc1c1f1549c961cfb8b420e650e1272b)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef	_DACF_H
#define	_DACF_H

#pragma ident	"%Z%%M%	%I%	%E% SMI"

/*
 * Device autoconfiguration framework (dacf)
 */

#ifdef	__cplusplus
extern "C" {
#endif

#include <sys/types.h>

#define	DACF_MODREV_1		1	/* interface version # */

typedef void* dacf_arghdl_t;
typedef void* dacf_infohdl_t;

typedef enum {
	DACF_OPID_ERROR = -1,
	DACF_OPID_END = 0,		/* mark end of array of dacf_op's */
	DACF_OPID_POSTATTACH = 1,	/* operate after a driver attaches */
	DACF_OPID_PREDETACH = 2		/* operate before a driver detaches */
} dacf_opid_t;

#define	DACF_NUM_OPIDS 2

typedef struct dacf_op {
	dacf_opid_t op_id;		/* operation id */
	int (*op_func)(dacf_infohdl_t, dacf_arghdl_t, int);
} dacf_op_t;

typedef struct dacf_opset {
	char *opset_name;		/* name of this op-set */
	dacf_op_t *opset_ops;		/* null-terminated array of ops */
} dacf_opset_t;

struct dacfsw {
	int		dacf_rev;	/* dacf interface revision #	*/
	dacf_opset_t	*dacf_opsets;	/* op-sets in this module	*/
};

extern struct dacfsw kmod_dacfsw;	/* kernel provided module */

/*
 * DACF client interface
 */

const char *dacf_minor_name(dacf_infohdl_t);
minor_t dacf_minor_number(dacf_infohdl_t);
dev_t dacf_get_dev(dacf_infohdl_t);
const char *dacf_driver_name(dacf_infohdl_t);
dev_info_t *dacf_devinfo_node(dacf_infohdl_t);
const char *dacf_get_arg(dacf_arghdl_t, char *);

void dacf_store_info(dacf_infohdl_t, void *);
void *dacf_retrieve_info(dacf_infohdl_t);

struct vnode *dacf_makevp(dacf_infohdl_t);

/*
 * Error codes for configuration operations
 */
#define	DACF_SUCCESS		0
#define	DACF_FAILURE		-1

#ifdef __cplusplus
}
#endif

#endif /* _DACF_H */