cam_xpt_internal.h revision 230590 
1/*-
2 * Copyright 2009 Scott Long
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions, and the following disclaimer,
10 *    without modification, immediately at the beginning of the file.
11 * 2. The name of the author may not be used to endorse or promote products
12 *    derived from this software without specific prior written permission.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/cam/cam_xpt_internal.h 230590 2012-01-26 18:09:28Z ken $
27 */
28
29#ifndef _CAM_CAM_XPT_INTERNAL_H
30#define _CAM_CAM_XPT_INTERNAL_H 1
31
32/* Forward Declarations */
33struct cam_eb;
34struct cam_et;
35struct cam_ed;
36
37typedef struct cam_ed * (*xpt_alloc_device_func)(struct cam_eb *bus,
38					         struct cam_et *target,
39					         lun_id_t lun_id);
40typedef void (*xpt_release_device_func)(struct cam_ed *device);
41typedef void (*xpt_action_func)(union ccb *start_ccb);
42typedef void (*xpt_dev_async_func)(u_int32_t async_code,
43				   struct cam_eb *bus,
44				   struct cam_et *target,
45				   struct cam_ed *device,
46				   void *async_arg);
47typedef void (*xpt_announce_periph_func)(struct cam_periph *periph);
48
49struct xpt_xport {
50	xpt_alloc_device_func	alloc_device;
51	xpt_release_device_func	reldev;
52	xpt_action_func		action;
53	xpt_dev_async_func	async;
54	xpt_announce_periph_func announce;
55};
56
57/*
58 * Structure for queueing a device in a run queue.
59 * There is one run queue for allocating new ccbs,
60 * and another for sending ccbs to the controller.
61 */
62struct cam_ed_qinfo {
63	cam_pinfo pinfo;
64	struct	  cam_ed *device;
65};
66
67/*
68 * The CAM EDT (Existing Device Table) contains the device information for
69 * all devices for all busses in the system.  The table contains a
70 * cam_ed structure for each device on the bus.
71 */
72struct cam_ed {
73	TAILQ_ENTRY(cam_ed) links;
74	struct	cam_ed_qinfo alloc_ccb_entry;
75	struct	cam_ed_qinfo send_ccb_entry;
76	struct	cam_et	 *target;
77	struct	cam_sim  *sim;
78	lun_id_t	 lun_id;
79	struct	camq drvq;		/*
80					 * Queue of type drivers wanting to do
81					 * work on this device.
82					 */
83	struct	cam_ccbq ccbq;		/* Queue of pending ccbs */
84	struct	async_list asyncs;	/* Async callback info for this B/T/L */
85	struct	periph_list periphs;	/* All attached devices */
86	u_int	generation;		/* Generation number */
87	struct	cam_periph *owner;	/* Peripheral driver's ownership tag */
88	void		 *quirk;	/* Oddities about this device */
89	u_int		 maxtags;
90	u_int		 mintags;
91	cam_proto	 protocol;
92	u_int		 protocol_version;
93	cam_xport	 transport;
94	u_int		 transport_version;
95	struct		 scsi_inquiry_data inq_data;
96	uint8_t		 *supported_vpds;
97	uint8_t		 supported_vpds_len;
98	uint32_t	 device_id_len;
99	uint8_t		 *device_id;
100	uint8_t		 physpath_len;
101	uint8_t		 *physpath;	/* physical path string form */
102	uint32_t	 rcap_len;
103	uint8_t		 *rcap_buf;
104	struct		 ata_params ident_data;
105	u_int8_t	 inq_flags;	/*
106					 * Current settings for inquiry flags.
107					 * This allows us to override settings
108					 * like disconnection and tagged
109					 * queuing for a device.
110					 */
111	u_int8_t	 queue_flags;	/* Queue flags from the control page */
112	u_int8_t	 serial_num_len;
113	u_int8_t	*serial_num;
114	u_int32_t	 flags;
115#define CAM_DEV_UNCONFIGURED	 	0x01
116#define CAM_DEV_REL_TIMEOUT_PENDING	0x02
117#define CAM_DEV_REL_ON_COMPLETE		0x04
118#define CAM_DEV_REL_ON_QUEUE_EMPTY	0x08
119#define CAM_DEV_RESIZE_QUEUE_NEEDED	0x10
120#define CAM_DEV_TAG_AFTER_COUNT		0x20
121#define CAM_DEV_INQUIRY_DATA_VALID	0x40
122#define	CAM_DEV_IN_DV			0x80
123#define	CAM_DEV_DV_HIT_BOTTOM		0x100
124#define CAM_DEV_IDENTIFY_DATA_VALID	0x200
125	u_int32_t	 tag_delay_count;
126#define	CAM_TAG_DELAY_COUNT		5
127	u_int32_t	 tag_saved_openings;
128	u_int32_t	 refcount;
129	struct callout	 callout;
130};
131
132/*
133 * Each target is represented by an ET (Existing Target).  These
134 * entries are created when a target is successfully probed with an
135 * identify, and removed when a device fails to respond after a number
136 * of retries, or a bus rescan finds the device missing.
137 */
138struct cam_et {
139	TAILQ_HEAD(, cam_ed) ed_entries;
140	TAILQ_ENTRY(cam_et) links;
141	struct	cam_eb	*bus;
142	target_id_t	target_id;
143	u_int32_t	refcount;
144	u_int		generation;
145	struct		timeval last_reset;
146	u_int		rpl_size;
147	struct scsi_report_luns_data *luns;
148};
149
150/*
151 * Each bus is represented by an EB (Existing Bus).  These entries
152 * are created by calls to xpt_bus_register and deleted by calls to
153 * xpt_bus_deregister.
154 */
155struct cam_eb {
156	TAILQ_HEAD(, cam_et) et_entries;
157	TAILQ_ENTRY(cam_eb)  links;
158	path_id_t	     path_id;
159	struct cam_sim	     *sim;
160	struct timeval	     last_reset;
161	u_int32_t	     flags;
162#define	CAM_EB_RUNQ_SCHEDULED	0x01
163	u_int32_t	     refcount;
164	u_int		     generation;
165	device_t	     parent_dev;
166	struct xpt_xport     *xport;
167};
168
169struct cam_path {
170	struct cam_periph *periph;
171	struct cam_eb	  *bus;
172	struct cam_et	  *target;
173	struct cam_ed	  *device;
174};
175
176struct xpt_xport *	scsi_get_xport(void);
177struct xpt_xport *	ata_get_xport(void);
178
179struct cam_ed *		xpt_alloc_device(struct cam_eb *bus,
180					 struct cam_et *target,
181					 lun_id_t lun_id);
182void			xpt_acquire_device(struct cam_ed *device);
183void			xpt_release_device(struct cam_ed *device);
184int			xpt_schedule_dev(struct camq *queue, cam_pinfo *dev_pinfo,
185					 u_int32_t new_priority);
186u_int32_t		xpt_dev_ccbq_resize(struct cam_path *path, int newopenings);
187void			xpt_start_tags(struct cam_path *path);
188void			xpt_stop_tags(struct cam_path *path);
189
190MALLOC_DECLARE(M_CAMXPT);
191
192#endif
193