1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda/*
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * CDDL HEADER START
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda *
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * The contents of this file are subject to the terms of the
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * Common Development and Distribution License (the "License").
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * You may not use this file except in compliance with the License.
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda *
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * or http://www.opensolaris.org/os/licensing.
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * See the License for the specific language governing permissions
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * and limitations under the License.
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda *
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * When distributing Covered Code, include this CDDL HEADER in each
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * If applicable, add the following below this CDDL HEADER, with the
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * fields enclosed by brackets "[]" replaced with your own identifying
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * information: Portions Copyright [yyyy] [name of copyright owner]
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda *
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * CDDL HEADER END
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda/*
02b4e56ca3a4e4a4fe9e52fca9c2972101f0e57fHaik Aftandilian * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#ifndef _SYS_DRCTL_H
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#define _SYS_DRCTL_H
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#ifdef __cplusplus
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedaextern "C" {
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#endif
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#define DRCTL_DEV "/devices/pseudo/drctl@0:drctl"
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedatypedef enum {
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_CPU_CONFIG_REQUEST = 1,
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_CPU_CONFIG_NOTIFY,
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_CPU_UNCONFIG_REQUEST,
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_CPU_UNCONFIG_NOTIFY,
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_MEM_CONFIG_REQUEST,
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_MEM_CONFIG_NOTIFY,
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_MEM_UNCONFIG_REQUEST,
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_MEM_UNCONFIG_NOTIFY,
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_IO_CONFIG_REQUEST,
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_IO_CONFIG_NOTIFY,
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_IO_UNCONFIG_REQUEST,
af4c679f647cf088543c762e33d41a3ac52cfa14Sean McEnroe DRCTL_IO_UNCONFIG_NOTIFY,
af4c679f647cf088543c762e33d41a3ac52cfa14Sean McEnroe DRCTL_DRC_BLOCK
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda} drctl_cmds_t;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda/*
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * Responses to/from the daemon for a reconfig request.
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedatypedef enum {
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_STATUS_INIT, /* to daemon */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_STATUS_ALLOW, /* from daemon */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_STATUS_DENY, /* from daemon */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_STATUS_CONFIG_SUCCESS, /* to daemon */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda DRCTL_STATUS_CONFIG_FAILURE /* to daemon */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda} drctl_status_t;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda/*
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * Each resource descriptor consists of a common header
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * followed by a resource-specific structure.
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedatypedef struct drctl_rsrc_cpu {
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda int id;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda} drctl_rsrc_cpu_t;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedatypedef struct drctl_rsrc_memory {
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda uint64_t size;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda uint64_t addr;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda} drctl_rsrc_mem_t;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedatypedef struct drctl_rsrc_dev {
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda char path[1];
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda} drctl_rsrc_dev_t;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedatypedef struct drctl_rsrc {
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda drctl_status_t status;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda uint64_t offset;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda union {
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda drctl_rsrc_cpu_t cpu;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda drctl_rsrc_mem_t mem;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda drctl_rsrc_dev_t dev;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda } un;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda} drctl_rsrc_t;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#define res_cpu_id un.cpu.id
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#define res_mem_size un.mem.size
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#define res_mem_addr un.mem.addr
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#define res_dev_path un.dev.path
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems/*
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems * Response structure passed back by drctl to its clients
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems * (resource-specific DR modules).
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems */
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystemstypedef enum {
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems DRCTL_RESP_ERR,
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems DRCTL_RESP_OK
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems} drctl_resp_type_t;
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystemstypedef struct drctl_resp {
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems drctl_resp_type_t resp_type;
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems union {
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems char err_msg[1];
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems drctl_rsrc_t resources[1];
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems } un;
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems} drctl_resp_t;
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems#define resp_err_msg un.err_msg
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems#define resp_resources un.resources
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda/*
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * Message sent to DR daemon
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedatypedef struct drd_msg {
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda uint_t cmd;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda uint_t count;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda int flags;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda drctl_rsrc_t data[1];
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda} drd_msg_t;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedatypedef void *drctl_cookie_t;
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda/*
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * DR RSMs (resource-specific modules) call these functions to
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * initialize or finalize a DR request. A request may include
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * multiple resources of the same type. The _init call returns
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * a cookie which must be supplied on by the corresponding
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * _fini call.
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedaextern int drctl_config_init(int, int,
99c7e85592b5d673f1469b2767f876710004dc23James Marks - Sun Microsystems drctl_rsrc_t *, int, drctl_resp_t **, size_t *, drctl_cookie_t);
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaedaextern int drctl_config_fini(drctl_cookie_t, drctl_rsrc_t *, int);
af4c679f647cf088543c762e33d41a3ac52cfa14Sean McEnroeextern void drctl_block(void);
02b4e56ca3a4e4a4fe9e52fca9c2972101f0e57fHaik Aftandilianextern int drctl_tryblock(void);
af4c679f647cf088543c762e33d41a3ac52cfa14Sean McEnroeextern void drctl_unblock(void);
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda/*
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda * Values for the 2nd arg (flags) of drctl_config_init
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda */
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#define DRCTL_FLAG_FORCE 1
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#ifdef __cplusplus
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda}
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#endif
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda
1d4b38e0077763e7c9b20768eacb841957e787bcrsmaeda#endif /* _SYS_DRCTL_H */