xref: /freebsd/sbin/camcontrol/camcontrol.h (revision bae28eaa8d26ddd67e9af51979f1a54599e9b3a8)
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$
29  */
30 
31 #ifndef _CAMCONTROL_H
32 #define _CAMCONTROL_H
33 
34 typedef enum {
35 	CC_OR_NOT_FOUND,
36 	CC_OR_AMBIGUOUS,
37 	CC_OR_FOUND
38 } camcontrol_optret;
39 
40 typedef 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  */
51 struct get_hook
52 {
53 	int argc;
54 	char **argv;
55 	int got;
56 };
57 
58 extern int verbose;
59 
60 int ata_do_identify(struct cam_device *device, int retry_count, int timeout,
61 		    union ccb *ccb, struct ata_params **ident_bufp);
62 int dev_has_vpd_page(struct cam_device *dev, uint8_t page_id, int retry_count,
63 		     int timeout, int verbosemode);
64 int get_device_type(struct cam_device *dev, int retry_count, int timeout,
65 		    int verbosemode, camcontrol_devtype *devtype);
66 void 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);
72 int camxferrate(struct cam_device *device);
73 int fwdownload(struct cam_device *device, int argc, char **argv,
74 	       char *combinedopt, int printerrors, int retry_count,
75 	       int timeout);
76 void mode_sense(struct cam_device *device, int mode_page, int page_control,
77 		int dbd, int retry_count, int timeout, u_int8_t *data,
78 		int datalen);
79 void mode_select(struct cam_device *device, int save_pages, int retry_count,
80 		 int timeout, u_int8_t *data, int datalen);
81 void mode_edit(struct cam_device *device, int page, int page_control, int dbd,
82 	       int edit, int binary, int retry_count, int timeout);
83 void mode_list(struct cam_device *device, int page_control, int dbd,
84 	       int retry_count, int timeout);
85 int scsidoinquiry(struct cam_device *device, int argc, char **argv,
86 		  char *combinedopt, int retry_count, int timeout);
87 int scsigetopcodes(struct cam_device *device, int opcode_set, int opcode,
88 		   int show_sa_errors, int sa_set, int service_action,
89 		   int timeout_desc, int retry_count, int timeout,
90 		   int verbosemode, uint32_t *fill_len, uint8_t **data_ptr);
91 int scsipersist(struct cam_device *device, int argc, char **argv,
92 		char *combinedopt, int retry_count, int timeout, int verbose,
93 		int err_recover);
94 int scsiattrib(struct cam_device *device, int argc, char **argv,
95 	       char *combinedopt, int retry_count, int timeout, int verbose,
96 	       int err_recover);
97 char *cget(void *hook, char *name);
98 int iget(void *hook, char *name);
99 void arg_put(void *hook, int letter, void *arg, int count, char *name);
100 int get_confirmation(void);
101 void usage(int printlong);
102 #endif /* _CAMCONTROL_H */
103