xref: /onnv-gate/usr/src/lib/libpcp/common/libpcp.h (revision 293:09ef6385fb82)
10Sstevel@tonic-gate /*
20Sstevel@tonic-gate  * CDDL HEADER START
30Sstevel@tonic-gate  *
40Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
50Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
60Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
70Sstevel@tonic-gate  * with the License.
80Sstevel@tonic-gate  *
90Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
100Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
110Sstevel@tonic-gate  * See the License for the specific language governing permissions
120Sstevel@tonic-gate  * and limitations under the License.
130Sstevel@tonic-gate  *
140Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
150Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
160Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
170Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
180Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
190Sstevel@tonic-gate  *
200Sstevel@tonic-gate  * CDDL HEADER END
210Sstevel@tonic-gate  */
220Sstevel@tonic-gate /*
230Sstevel@tonic-gate  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
240Sstevel@tonic-gate  * Use is subject to license terms.
250Sstevel@tonic-gate  */
260Sstevel@tonic-gate 
270Sstevel@tonic-gate #ifndef	_LIBPCP_H
280Sstevel@tonic-gate #define	_LIBPCP_H
290Sstevel@tonic-gate 
300Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
310Sstevel@tonic-gate 
320Sstevel@tonic-gate #ifdef	__cplusplus
330Sstevel@tonic-gate extern "C" {
340Sstevel@tonic-gate #endif
350Sstevel@tonic-gate 
360Sstevel@tonic-gate #define	PCPL_MAX_TRY_CNT	5
370Sstevel@tonic-gate #define	PCP_CLEANUP_TIMEOUT	3
380Sstevel@tonic-gate 
390Sstevel@tonic-gate #define	PCPL_DEF_MTU_SZ		100
400Sstevel@tonic-gate 
410Sstevel@tonic-gate 
420Sstevel@tonic-gate #define	PCPL_IO_OP_READ		(1)
430Sstevel@tonic-gate #define	PCPL_IO_OP_WRITE	(2)
440Sstevel@tonic-gate #define	PCPL_IO_OP_PEEK		(3)
450Sstevel@tonic-gate 
460Sstevel@tonic-gate /*
470Sstevel@tonic-gate  * sleep (seconds) for glvc call failures before
480Sstevel@tonic-gate  * retrying.
490Sstevel@tonic-gate  */
500Sstevel@tonic-gate #define	PCPL_GLVC_SLEEP		(5)
510Sstevel@tonic-gate 
520Sstevel@tonic-gate /*
530Sstevel@tonic-gate  * Error codes for pcp library that are
540Sstevel@tonic-gate  * returned to users applications.
550Sstevel@tonic-gate  */
560Sstevel@tonic-gate #define	PCPL_OK			0
570Sstevel@tonic-gate #define	PCPL_ERROR		(-1)
580Sstevel@tonic-gate #define	PCPL_INVALID_ARGS 	(-2)
590Sstevel@tonic-gate #define	PCPL_GLVC_ERROR		(-3)
600Sstevel@tonic-gate #define	PCPL_XPORT_ERROR	(-4)
610Sstevel@tonic-gate #define	PCPL_MALLOC_FAIL	(-5)
620Sstevel@tonic-gate #define	PCPL_GLVC_TIMEOUT	(-6)
630Sstevel@tonic-gate #define	PCPL_FRAME_ERROR	(-7)
640Sstevel@tonic-gate #define	PCPL_CKSUM_ERROR	(-8)
650Sstevel@tonic-gate #define	PCPL_PROT_ERROR		(-9)
660Sstevel@tonic-gate 
670Sstevel@tonic-gate /* common defines */
680Sstevel@tonic-gate #ifndef	MIN
690Sstevel@tonic-gate #define	MIN(x, y) ((x) < (y) ? (x) : (y))
700Sstevel@tonic-gate #endif
710Sstevel@tonic-gate #ifndef	MAX
720Sstevel@tonic-gate #define	MAX(x, y) ((x) > (y) ? (x) : (y))
730Sstevel@tonic-gate #endif
740Sstevel@tonic-gate #ifndef	ABS
750Sstevel@tonic-gate #define	ABS(x)	((x) < (0) ? (-(x)) : (x))
760Sstevel@tonic-gate #endif
770Sstevel@tonic-gate 
780Sstevel@tonic-gate /*
790Sstevel@tonic-gate  * PCP user apps message format
800Sstevel@tonic-gate  */
810Sstevel@tonic-gate typedef struct pcp_msg {
820Sstevel@tonic-gate 	uint8_t	msg_type;
830Sstevel@tonic-gate 	uint8_t	sub_type;
84*126Smvgr 	uint16_t rsvd_pad;
850Sstevel@tonic-gate 	uint32_t msg_len;
860Sstevel@tonic-gate 	void *msg_data;
870Sstevel@tonic-gate } pcp_msg_t;
880Sstevel@tonic-gate 
89*126Smvgr int pcp_init(char *channel_name);
90*126Smvgr int pcp_send_recv(int channel_fd, pcp_msg_t *req_msg, pcp_msg_t *resp_msg,
91*126Smvgr 			uint32_t timeout);
92*126Smvgr int pcp_close(int channel_fd);
930Sstevel@tonic-gate 
940Sstevel@tonic-gate #ifdef	__cplusplus
950Sstevel@tonic-gate }
960Sstevel@tonic-gate #endif
970Sstevel@tonic-gate 
980Sstevel@tonic-gate #endif /* _LIBPCP_H */
99