xref: /freebsd/sys/dev/qlxgbe/ql_ioctl.h (revision 3fc36ee018bb836bd1796067cf4ef8683f166ebc)
1 /*
2  * Copyright (c) 2013-2016 Qlogic Corporation
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  *
9  *  1. Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  *  2. Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  *
15  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25  *  POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 /*
30  * File: ql_ioctl.h
31  * Author : David C Somayajulu, Qlogic Corporation, Aliso Viejo, CA 92656.
32  */
33 
34 #ifndef _QL_IOCTL_H_
35 #define _QL_IOCTL_H_
36 
37 #include <sys/ioccom.h>
38 
39 struct qla_reg_val {
40         uint16_t rd;
41         uint16_t direct;
42         uint32_t reg;
43         uint32_t val;
44 };
45 typedef struct qla_reg_val qla_reg_val_t;
46 
47 struct qla_rd_flash {
48         uint32_t off;
49         uint32_t data;
50 };
51 typedef struct qla_rd_flash qla_rd_flash_t;
52 
53 struct qla_wr_flash {
54 	uint32_t off;
55 	uint32_t size;
56 	void *buffer;
57 	uint32_t pattern;
58 };
59 typedef struct qla_wr_flash qla_wr_flash_t;
60 
61 struct qla_erase_flash {
62 	uint32_t off;
63 	uint32_t size;
64 };
65 typedef struct qla_erase_flash qla_erase_flash_t;
66 
67 struct qla_rd_pci_ids {
68 	uint16_t ven_id;
69 	uint16_t dev_id;
70 	uint16_t subsys_ven_id;
71 	uint16_t subsys_dev_id;
72 	uint8_t rev_id;
73 };
74 typedef struct qla_rd_pci_ids qla_rd_pci_ids_t;
75 
76 /*
77  * structure encapsulating the value to read/write from/to offchip (MS) memory
78  */
79 struct qla_offchip_mem_val {
80 	uint16_t rd;
81 	uint64_t off;
82 	uint32_t data_lo;
83 	uint32_t data_hi;
84 	uint32_t data_ulo;
85 	uint32_t data_uhi;
86 };
87 typedef struct qla_offchip_mem_val qla_offchip_mem_val_t;
88 
89 struct qla_rd_fw_dump {
90 	uint16_t pci_func;
91 	uint32_t minidump_size;
92 	void *minidump;
93 };
94 typedef struct qla_rd_fw_dump qla_rd_fw_dump_t;
95 
96 /*
97  * Read/Write Register
98  */
99 #define QLA_RDWR_REG		_IOWR('q', 1, qla_reg_val_t)
100 
101 /*
102  * Read Flash
103  */
104 #define QLA_RD_FLASH		_IOWR('q', 2, qla_rd_flash_t)
105 
106 /*
107  * Write Flash
108  */
109 #define QLA_WR_FLASH		_IOWR('q', 3, qla_wr_flash_t)
110 
111 /*
112  * Read Offchip (MS) Memory
113  */
114 #define QLA_RDWR_MS_MEM		_IOWR('q', 4, qla_offchip_mem_val_t)
115 
116 /*
117  * Erase Flash
118  */
119 #define QLA_ERASE_FLASH		_IOWR('q', 5, qla_erase_flash_t)
120 
121 /*
122  * Read PCI IDs
123  */
124 #define QLA_RD_PCI_IDS		_IOWR('q', 6, qla_rd_pci_ids_t)
125 
126 /*
127  * Read Minidump Template Size
128  */
129 #define QLA_RD_FW_DUMP_SIZE	_IOWR('q', 7, qla_rd_fw_dump_t)
130 
131 /*
132  * Read Minidump Template
133  */
134 #define QLA_RD_FW_DUMP		_IOWR('q', 8, qla_rd_fw_dump_t)
135 
136 #endif /* #ifndef _QL_IOCTL_H_ */
137