1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2003-2009 Silicon Graphics International Corp.
5 * Copyright (c) 2011 Spectra Logic Corporation
6 * Copyright (c) 2015 Alexander Motin <mav@FreeBSD.org>
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions, and the following disclaimer,
14 *    without modification.
15 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
16 *    substantially similar to the "NO WARRANTY" disclaimer below
17 *    ("Disclaimer") and any redistribution must be conditioned upon
18 *    including a substantially similar Disclaimer requirement for further
19 *    binary redistribution.
20 *
21 * NO WARRANTY
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
31 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGES.
33 *
34 * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_ha.h#1 $
35 */
36
37#ifndef _CTL_HA_H_
38#define	_CTL_HA_H_
39
40#include <sys/queue.h>
41
42/*
43 * CTL High Availability Modes:
44 *
45 * CTL_HA_MODE_ACT_STBY:  Commands are serialized to the master side.
46 *			  No media access commands on slave side (Standby).
47 * CTL_HA_MODE_SER_ONLY:  Commands are serialized to the master side.
48 *			  Media can be accessed on both sides.
49 * CTL_HA_MODE_XFER:	  Commands and data are forwarded to the
50 *			  master side for execution.
51 */
52typedef enum {
53	CTL_HA_MODE_ACT_STBY,
54	CTL_HA_MODE_SER_ONLY,
55	CTL_HA_MODE_XFER
56} ctl_ha_mode;
57
58/*
59 * Communication channel IDs for various system components.  This is to
60 * make sure one CTL instance talks with another, one ZFS instance talks
61 * with another, etc.
62 */
63typedef enum {
64	CTL_HA_CHAN_CTL,
65	CTL_HA_CHAN_DATA,
66	CTL_HA_CHAN_MAX
67} ctl_ha_channel;
68
69/*
70 * HA communication event notification.  These are events generated by the
71 * HA communication subsystem.
72 *
73 * CTL_HA_EVT_MSG_RECV:		Message received by the other node.
74 * CTL_HA_EVT_LINK_CHANGE:	Communication channel status changed.
75 */
76typedef enum {
77	CTL_HA_EVT_NONE,
78	CTL_HA_EVT_MSG_RECV,
79	CTL_HA_EVT_LINK_CHANGE,
80	CTL_HA_EVT_MAX
81} ctl_ha_event;
82
83typedef enum {
84	CTL_HA_STATUS_WAIT,
85	CTL_HA_STATUS_SUCCESS,
86	CTL_HA_STATUS_ERROR,
87	CTL_HA_STATUS_INVALID,
88	CTL_HA_STATUS_DISCONNECT,
89	CTL_HA_STATUS_BUSY,
90	CTL_HA_STATUS_MAX
91} ctl_ha_status;
92
93typedef enum {
94	CTL_HA_DT_CMD_READ,
95	CTL_HA_DT_CMD_WRITE,
96} ctl_ha_dt_cmd;
97
98struct ctl_ha_dt_req;
99
100typedef void (*ctl_ha_dt_cb)(struct ctl_ha_dt_req *);
101
102struct ctl_ha_dt_req {
103	ctl_ha_dt_cmd	command;
104	void		*context;
105	ctl_ha_dt_cb	callback;
106	int		ret;
107	uint32_t	size;
108	uint8_t		*local;
109	uint8_t		*remote;
110	TAILQ_ENTRY(ctl_ha_dt_req)	 links;
111};
112
113struct ctl_softc;
114ctl_ha_status ctl_ha_msg_init(struct ctl_softc *softc);
115void ctl_ha_msg_shutdown(struct ctl_softc *softc);
116ctl_ha_status ctl_ha_msg_destroy(struct ctl_softc *softc);
117
118typedef void (*ctl_evt_handler)(ctl_ha_channel channel, ctl_ha_event event,
119				int param);
120void ctl_ha_register_evthandler(ctl_ha_channel channel,
121				ctl_evt_handler handler);
122
123ctl_ha_status ctl_ha_msg_register(ctl_ha_channel channel,
124    ctl_evt_handler handler);
125ctl_ha_status ctl_ha_msg_recv(ctl_ha_channel channel, void *addr,
126    size_t len, int wait);
127ctl_ha_status ctl_ha_msg_send(ctl_ha_channel channel, const void *addr,
128    size_t len, int wait);
129ctl_ha_status ctl_ha_msg_send2(ctl_ha_channel channel, const void *addr,
130    size_t len, const void *addr2, size_t len2, int wait);
131ctl_ha_status ctl_ha_msg_abort(ctl_ha_channel channel);
132ctl_ha_status ctl_ha_msg_deregister(ctl_ha_channel channel);
133
134struct ctl_ha_dt_req * ctl_dt_req_alloc(void);
135void ctl_dt_req_free(struct ctl_ha_dt_req *req);
136ctl_ha_status ctl_dt_single(struct ctl_ha_dt_req *req);
137
138typedef enum {
139	CTL_HA_LINK_OFFLINE	= 0x00,
140	CTL_HA_LINK_UNKNOWN	= 0x01,
141	CTL_HA_LINK_ONLINE	= 0x02
142} ctl_ha_link_state;
143
144#endif /* _CTL_HA_H_ */
145