03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * CDDL HEADER START
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * The contents of this file are subject to the terms of the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Common Development and Distribution License (the "License").
03831d35f7499c87d51205817c93e9a8d42c4baestevel * You may not use this file except in compliance with the License.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
03831d35f7499c87d51205817c93e9a8d42c4baestevel * or http://www.opensolaris.org/os/licensing.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * See the License for the specific language governing permissions
03831d35f7499c87d51205817c93e9a8d42c4baestevel * and limitations under the License.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * When distributing Covered Code, include this CDDL HEADER in each
03831d35f7499c87d51205817c93e9a8d42c4baestevel * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * If applicable, add the following below this CDDL HEADER, with the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * fields enclosed by brackets "[]" replaced with your own identifying
03831d35f7499c87d51205817c93e9a8d42c4baestevel * information: Portions Copyright [yyyy] [name of copyright owner]
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * CDDL HEADER END
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Copyright 2000 Sun Microsystems, Inc. All rights reserved.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Use is subject to license terms.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifndef _MBOXSC_H
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define _MBOXSC_H
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#pragma ident "%Z%%M% %I% %E% SMI"
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * This file defines the Starcat Domain Mailbox Interface, as implemented in
03831d35f7499c87d51205817c93e9a8d42c4baestevel * the mboxsc module.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef __cplusplus
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern "C" {
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <sys/types.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Mailbox message types, for use in mboxsc_putmsg() and mboxsc_getmsg() calls.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * NOTE: Clients should not use the MBOXSC_NUM_MSG_TYPES value, which
03831d35f7499c87d51205817c93e9a8d42c4baestevel * is used internally to simplify future code maintenance.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_MSG_REQUEST 0x01
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_MSG_REPLY 0x02
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_MSG_EVENT 0x04
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_NUM_MSG_TYPES 3
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Mailbox directions, for use in mboxsc_init().
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_MBOX_IN 0
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_MBOX_OUT 1
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef _KERNEL
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Mailbox control commands, for use in mboxsc_ctrl().
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_CMD_VERSION 1
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_CMD_MAXVERSION 2
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_CMD_MAXDATALEN 3
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_CMD_PUTMSG_TIMEOUT_RANGE 4
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_CMD_GETMSG_TIMEOUT_RANGE 5
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * The argument for the TIMEOUT_RANGE control commands is a pointer to one of
03831d35f7499c87d51205817c93e9a8d42c4baestevel * these.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baesteveltypedef struct mboxsc_timeout_range {
03831d35f7499c87d51205817c93e9a8d42c4baestevel clock_t min_timeout;
03831d35f7499c87d51205817c93e9a8d42c4baestevel clock_t max_timeout;
03831d35f7499c87d51205817c93e9a8d42c4baestevel} mboxsc_timeout_range_t;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Mailbox interface functions available to in-kernel clients on Starcat
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Domains.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * NOTE: The timeout arguments to mboxsc_putmsg() and mboxsc_getmsg() are
03831d35f7499c87d51205817c93e9a8d42c4baestevel * interpreted as milliseconds.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern int mboxsc_init(uint32_t key, int direction, void
03831d35f7499c87d51205817c93e9a8d42c4baestevel (*event_handler)(void));
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern int mboxsc_fini(uint32_t key);
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern int mboxsc_putmsg(uint32_t key, uint32_t type, uint32_t cmd,
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint64_t *transid, uint32_t length, void *datap, clock_t timeout);
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern int mboxsc_getmsg(uint32_t key, uint32_t *type, uint32_t *cmd,
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint64_t *transid, uint32_t *length, void *datap, clock_t timeout);
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern int mboxsc_ctrl(uint32_t key, uint32_t cmd, void *arg);
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern clock_t mboxsc_putmsg_def_timeout(void);
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_PUTMSG_DEF_TIMEOUT mboxsc_putmsg_def_timeout()
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef DEBUG
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * The following commands may be passed in to the mboxsc_debug() function to
03831d35f7499c87d51205817c93e9a8d42c4baestevel * dump data to the console that wouldn't be available through normal
03831d35f7499c87d51205817c93e9a8d42c4baestevel * (non-debug) functions.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_PRNMBOX 1 /* display a particular mailbox */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_PRNHASHTBL 2 /* display the whole hash table */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define MBOXSC_SETDBGMASK 3 /* set the debug mask */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Debugging interface routine.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern int mboxsc_debug(int cmd, void *arg);
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif /* DEBUG */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif /* _KERNEL */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef __cplusplus
03831d35f7499c87d51205817c93e9a8d42c4baestevel}
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif /* _MBOXSC_H */