xref: /freebsd/sbin/camcontrol/camcontrol.h (revision 97549c34ecaf74580941fdc9c5bd1050e4b1f6ce)
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 int 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, uint32_t auxiliary, uint8_t *data_ptr,
70 		  uint32_t dxfer_len, uint8_t *cdb_storage,
71 		  size_t cdb_storage_len, uint8_t sense_len, uint32_t timeout,
72 		  int is48bit, camcontrol_devtype devtype);
73 int get_ata_status(struct cam_device *dev, union ccb *ccb, uint8_t *error,
74 		   uint16_t *count, uint64_t *lba, uint8_t *device,
75 		   uint8_t *status);
76 int camxferrate(struct cam_device *device);
77 int fwdownload(struct cam_device *device, int argc, char **argv,
78 	       char *combinedopt, int printerrors, int retry_count,
79 	       int timeout);
80 int zone(struct cam_device *device, int argc, char **argv, char *combinedopt,
81 	 int retry_count, int timeout, int verbosemode);
82 int epc(struct cam_device *device, int argc, char **argv, char *combinedopt,
83 	int retry_count, int timeout, int verbosemode);
84 void mode_sense(struct cam_device *device, int mode_page, int page_control,
85 		int dbd, int retry_count, int timeout, u_int8_t *data,
86 		int datalen);
87 void mode_select(struct cam_device *device, int save_pages, int retry_count,
88 		 int timeout, u_int8_t *data, int datalen);
89 void mode_edit(struct cam_device *device, int page, int page_control, int dbd,
90 	       int edit, int binary, int retry_count, int timeout);
91 void mode_list(struct cam_device *device, int page_control, int dbd,
92 	       int retry_count, int timeout);
93 int scsidoinquiry(struct cam_device *device, int argc, char **argv,
94 		  char *combinedopt, int retry_count, int timeout);
95 int scsigetopcodes(struct cam_device *device, int opcode_set, int opcode,
96 		   int show_sa_errors, int sa_set, int service_action,
97 		   int timeout_desc, int retry_count, int timeout,
98 		   int verbosemode, uint32_t *fill_len, uint8_t **data_ptr);
99 int scsipersist(struct cam_device *device, int argc, char **argv,
100 		char *combinedopt, int retry_count, int timeout, int verbose,
101 		int err_recover);
102 int scsiattrib(struct cam_device *device, int argc, char **argv,
103 	       char *combinedopt, int retry_count, int timeout, int verbose,
104 	       int err_recover);
105 char *cget(void *hook, char *name);
106 int iget(void *hook, char *name);
107 void arg_put(void *hook, int letter, void *arg, int count, char *name);
108 int get_confirmation(void);
109 void usage(int printlong);
110 #endif /* _CAMCONTROL_H */
111