1/*
2 * Copyright (c) 1998 Kenneth D. Merry.
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 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 *    derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD: stable/10/sbin/camcontrol/camcontrol.h 314221 2017-02-24 20:51:39Z ken $
29 */
30
31#ifndef _CAMCONTROL_H
32#define _CAMCONTROL_H
33
34typedef enum {
35	CC_OR_NOT_FOUND,
36	CC_OR_AMBIGUOUS,
37	CC_OR_FOUND
38} camcontrol_optret;
39
40typedef enum {
41	CC_DT_NONE,
42	CC_DT_SCSI,
43	CC_DT_ATA_BEHIND_SCSI,
44	CC_DT_ATA,
45	CC_DT_UNKNOWN
46} camcontrol_devtype;
47
48/*
49 * get_hook: Structure for evaluating args in a callback.
50 */
51struct get_hook
52{
53	int argc;
54	char **argv;
55	int got;
56};
57
58extern int verbose;
59
60int ata_do_identify(struct cam_device *device, int retry_count, int timeout,
61		    union ccb *ccb, struct ata_params **ident_bufp);
62int dev_has_vpd_page(struct cam_device *dev, uint8_t page_id, int retry_count,
63		     int timeout, int verbosemode);
64int get_device_type(struct cam_device *dev, int retry_count, int timeout,
65		    int verbosemode, camcontrol_devtype *devtype);
66void build_ata_cmd(union ccb *ccb, uint32_t retry_count, uint32_t flags,
67		   uint8_t tag_action, uint8_t protocol, uint8_t ata_flags,
68		   uint16_t features, uint16_t sector_count, uint64_t lba,
69		   uint8_t command, uint8_t *data_ptr, uint16_t dxfer_len,
70		   uint8_t sense_len, uint32_t timeout, int is48bit,
71		   camcontrol_devtype devtype);
72int camxferrate(struct cam_device *device);
73int fwdownload(struct cam_device *device, int argc, char **argv,
74	       char *combinedopt, int printerrors, int task_attr,
75	       int retry_count, int timeout);
76void mode_sense(struct cam_device *device, int dbd, int pc, int page,
77		int subpage, int task_attr, int retry_count, int timeout,
78		uint8_t *data, int datalen);
79void mode_select(struct cam_device *device, int save_pages, int task_attr,
80		 int retry_count, int timeout, u_int8_t *data, int datalen);
81void mode_edit(struct cam_device *device, int dbd, int pc, int page,
82	       int subpage, int edit, int binary, int task_attr,
83	       int retry_count, int timeout);
84void mode_list(struct cam_device *device, int dbd, int pc, int subpages,
85	       int task_attr, int retry_count, int timeout);
86int scsidoinquiry(struct cam_device *device, int argc, char **argv,
87		  char *combinedopt, int task_attr, int retry_count,
88		  int timeout);
89int scsigetopcodes(struct cam_device *device, int opcode_set, int opcode,
90		   int show_sa_errors, int sa_set, int service_action,
91		   int timeout_desc, int task_attr, int retry_count,
92		   int timeout, int verbosemode, uint32_t *fill_len,
93		   uint8_t **data_ptr);
94int scsipersist(struct cam_device *device, int argc, char **argv,
95		char *combinedopt, int task_attr, int retry_count,
96		int timeout, int verbose, int err_recover);
97int scsiattrib(struct cam_device *device, int argc, char **argv,
98	       char *combinedopt, int task_attr, int retry_count, int timeout,
99	       int verbose, int err_recover);
100char *cget(void *hook, char *name);
101int iget(void *hook, char *name);
102void arg_put(void *hook, int letter, void *arg, int count, char *name);
103int get_confirmation(void);
104void usage(int printlong);
105#endif /* _CAMCONTROL_H */
106