2 * Copyright (c) 2018 Microsemi Corporation.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
18 * FOR 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
29 #ifndef _PQI_PROTOTYPES_H
30 #define _PQI_PROTOTYPES_H
32 /* Function prototypes */
35 int pqisrc_init(pqisrc_softstate_t *);
36 void pqisrc_uninit(pqisrc_softstate_t *);
37 void pqisrc_pqi_uninit(pqisrc_softstate_t *);
38 int pqisrc_process_config_table(pqisrc_softstate_t *);
39 int pqisrc_flush_cache(pqisrc_softstate_t *, enum pqisrc_flush_cache_event_type);
40 int pqisrc_wait_for_pqi_reset_completion(pqisrc_softstate_t *);
41 int pqisrc_wait_for_cmnd_complete(pqisrc_softstate_t *);
42 void pqisrc_complete_internal_cmds(pqisrc_softstate_t *);
45 int pqisrc_sis_init(pqisrc_softstate_t *);
46 void pqisrc_sis_uninit(pqisrc_softstate_t *);
47 int pqisrc_reenable_sis(pqisrc_softstate_t *);
48 void pqisrc_trigger_nmi_sis(pqisrc_softstate_t *);
49 void sis_disable_msix(pqisrc_softstate_t *);
50 void sis_enable_intx(pqisrc_softstate_t *);
51 void sis_disable_intx(pqisrc_softstate_t *softs);
52 int pqisrc_force_sis(pqisrc_softstate_t *);
53 int pqisrc_sis_wait_for_db_bit_to_clear(pqisrc_softstate_t *, uint32_t);
54 void sis_disable_interrupt(pqisrc_softstate_t*);
57 int pqisrc_submit_admin_req(pqisrc_softstate_t *,
58 gen_adm_req_iu_t *, gen_adm_resp_iu_t *);
59 int pqisrc_create_admin_queue(pqisrc_softstate_t *);
60 int pqisrc_destroy_admin_queue(pqisrc_softstate_t *);
61 int pqisrc_create_op_queues(pqisrc_softstate_t *);
64 int pqisrc_submit_cmnd(pqisrc_softstate_t *,ib_queue_t *,void *);
67 #ifndef LOCKFREE_STACK
68 int pqisrc_init_taglist(pqisrc_softstate_t *,pqi_taglist_t *,uint32_t);
69 void pqisrc_destroy_taglist(pqisrc_softstate_t *,pqi_taglist_t *);
70 void pqisrc_put_tag(pqi_taglist_t *,uint32_t);
71 uint32_t pqisrc_get_tag(pqi_taglist_t *);
73 int pqisrc_init_taglist(pqisrc_softstate_t *, lockless_stack_t *, uint32_t);
74 void pqisrc_destroy_taglist(pqisrc_softstate_t *, lockless_stack_t *);
75 void pqisrc_put_tag(lockless_stack_t *,uint32_t);
76 uint32_t pqisrc_get_tag(lockless_stack_t *);
77 #endif /* LOCKFREE_STACK */
80 void pqisrc_remove_device(pqisrc_softstate_t *, pqi_scsi_dev_t *);
81 int pqisrc_get_ctrl_fw_version(pqisrc_softstate_t *);
82 int pqisrc_rescan_devices(pqisrc_softstate_t *);
83 int pqisrc_scan_devices(pqisrc_softstate_t *);
84 void pqisrc_process_raid_path_io_response(pqisrc_softstate_t *, uint16_t, struct pqi_io_response *);
85 void pqisrc_process_io_error_response(pqisrc_softstate_t *, int, uint16_t, struct pqi_io_response *);
86 void pqisrc_cleanup_devices(pqisrc_softstate_t *);
87 void pqisrc_device_mem_free(pqisrc_softstate_t *, pqi_scsi_dev_t *);
88 boolean_t pqisrc_is_external_raid_device(pqi_scsi_dev_t *device);
89 void pqisrc_free_device(pqisrc_softstate_t * softs,pqi_scsi_dev_t *device);
90 void pqisrc_init_targetid_pool(pqisrc_softstate_t *softs);
91 int pqisrc_alloc_tid(pqisrc_softstate_t *softs);
92 void pqisrc_free_tid(pqisrc_softstate_t *softs, int);
95 boolean_t pqisrc_ctrl_offline(pqisrc_softstate_t *);
96 void pqisrc_heartbeat_timer_handler(pqisrc_softstate_t *);
97 int pqisrc_wait_on_condition(pqisrc_softstate_t *, rcb_t *);
98 boolean_t pqisrc_device_equal(pqi_scsi_dev_t *, pqi_scsi_dev_t *);
99 boolean_t pqisrc_is_hba_lunid(uint8_t *);
100 boolean_t pqisrc_is_logical_device(pqi_scsi_dev_t *);
101 void pqisrc_sanitize_inquiry_string(unsigned char *, int );
102 void pqisrc_display_device_info(pqisrc_softstate_t *, char *, pqi_scsi_dev_t *);
103 boolean_t pqisrc_scsi3addr_equal(uint8_t *, uint8_t *);
104 void check_struct_sizes(void);
105 char *pqisrc_raidlevel_to_string(uint8_t);
106 void pqisrc_configure_legacy_intx(pqisrc_softstate_t*, boolean_t);
109 void pqisrc_signal_event(pqisrc_softstate_t *softs, rcb_t *rcb);
110 void pqisrc_process_internal_raid_response_success(pqisrc_softstate_t *,
112 void pqisrc_process_internal_raid_response_error(pqisrc_softstate_t *,
114 void pqisrc_process_io_response_success(pqisrc_softstate_t *,
116 void pqisrc_process_aio_response_error(pqisrc_softstate_t *,
118 void pqisrc_process_raid_response_error(pqisrc_softstate_t *,
120 void pqisrc_process_response_queue(pqisrc_softstate_t *, int);
123 int pqisrc_build_send_io(pqisrc_softstate_t *,rcb_t *);
125 int pqisrc_send_scsi_cmd_raidbypass(pqisrc_softstate_t *softs,
126 pqi_scsi_dev_t *device, rcb_t *rcb, uint8_t*);
128 int pqisrc_send_tmf(pqisrc_softstate_t *, pqi_scsi_dev_t *,
130 int pqisrc_write_current_time_to_host_wellness(pqisrc_softstate_t *softs);
131 int pqisrc_write_driver_version_to_host_wellness(pqisrc_softstate_t *softs);
134 int pqisrc_report_event_config(pqisrc_softstate_t *);
135 int pqisrc_set_event_config(pqisrc_softstate_t *);
136 int pqisrc_process_event_intr_src(pqisrc_softstate_t *,int);
137 void pqisrc_ack_all_events(void *arg);
139 void pqisrc_event_worker(void *, int);
140 int pqisrc_scsi_setup(struct pqisrc_softstate *);
141 void pqisrc_scsi_cleanup(struct pqisrc_softstate *);
142 boolean_t pqisrc_update_scsi_sense(const uint8_t *, int,
143 struct sense_header_scsi *);
144 int pqisrc_build_send_raid_request(pqisrc_softstate_t *, pqisrc_raid_req_t *,
145 void *, size_t, uint8_t, uint16_t, uint8_t *,
146 raid_path_error_info_elem_t *);
148 int pqisrc_submit_management_req(pqisrc_softstate_t *,
149 pqi_event_config_request_t *);
150 void pqisrc_take_devices_offline(pqisrc_softstate_t *);
151 void pqisrc_take_ctrl_offline(pqisrc_softstate_t *);
152 void pqisrc_free_rcb(pqisrc_softstate_t *, int);
153 void pqisrc_decide_opq_config(pqisrc_softstate_t *);
154 int pqisrc_configure_op_queues(pqisrc_softstate_t *);
155 int pqisrc_pqi_init(pqisrc_softstate_t *);
156 int pqi_reset(pqisrc_softstate_t *);
157 int pqisrc_check_pqimode(pqisrc_softstate_t *);
158 int pqisrc_check_fw_status(pqisrc_softstate_t *);
159 int pqisrc_init_struct_base(pqisrc_softstate_t *);
160 int pqisrc_get_sis_pqi_cap(pqisrc_softstate_t *);
161 int pqisrc_get_preferred_settings(pqisrc_softstate_t *);
162 int pqisrc_get_adapter_properties(pqisrc_softstate_t *,
163 uint32_t *, uint32_t *);
165 void pqisrc_get_admin_queue_config(pqisrc_softstate_t *);
166 void pqisrc_decide_admin_queue_config(pqisrc_softstate_t *);
167 int pqisrc_allocate_and_init_adminq(pqisrc_softstate_t *);
168 int pqisrc_create_delete_adminq(pqisrc_softstate_t *, uint32_t);
169 void pqisrc_print_adminq_config(pqisrc_softstate_t *);
170 int pqisrc_delete_op_queue(pqisrc_softstate_t *,
171 uint32_t, boolean_t);
172 void pqisrc_destroy_event_queue(pqisrc_softstate_t *);
174 void pqisrc_destroy_op_ib_queues(pqisrc_softstate_t *);
176 void pqisrc_destroy_op_ob_queues(pqisrc_softstate_t *);
178 int pqisrc_change_op_ibq_queue_prop(pqisrc_softstate_t *,
179 ib_queue_t *, uint32_t);
180 int pqisrc_create_op_obq(pqisrc_softstate_t *,
182 int pqisrc_create_op_ibq(pqisrc_softstate_t *,
184 int pqisrc_create_op_aio_ibq(pqisrc_softstate_t *, ib_queue_t *);
185 int pqisrc_create_op_raid_ibq(pqisrc_softstate_t *, ib_queue_t *);
186 int pqisrc_alloc_and_create_event_queue(pqisrc_softstate_t *);
187 int pqisrc_alloc_and_create_ib_queues(pqisrc_softstate_t *);
188 int pqisrc_alloc_and_create_ob_queues(pqisrc_softstate_t *);
189 int pqisrc_process_task_management_response(pqisrc_softstate_t *,
191 void pqisrc_wait_for_rescan_complete(pqisrc_softstate_t *softs);
196 pqisrc_passthru_ioctl(struct pqisrc_softstate *, void *, int);
198 /* Functions Prototypes */
200 int os_dma_mem_alloc(pqisrc_softstate_t *,struct dma_mem *);
201 void os_dma_mem_free(pqisrc_softstate_t *,struct dma_mem *);
202 void *os_mem_alloc(pqisrc_softstate_t *,size_t);
203 void os_mem_free(pqisrc_softstate_t *,char *,size_t);
204 void os_resource_free(pqisrc_softstate_t *);
207 int os_get_intr_config(pqisrc_softstate_t *);
208 int os_setup_intr(pqisrc_softstate_t *);
209 int os_destroy_intr(pqisrc_softstate_t *);
210 int os_get_processor_config(pqisrc_softstate_t *);
211 void os_free_intr_config(pqisrc_softstate_t *);
213 /* FreeBSD_ioctl.c */
214 int os_copy_to_user(struct pqisrc_softstate *, void *,
216 int os_copy_from_user(struct pqisrc_softstate *, void *,
218 int create_char_dev(struct pqisrc_softstate *, int);
219 void destroy_char_dev(struct pqisrc_softstate *);
222 int os_init_spinlock(struct pqisrc_softstate *, struct mtx *, char *);
223 void os_uninit_spinlock(struct mtx *);
224 int os_create_semaphore(const char *, int,struct sema *);
225 int os_destroy_semaphore(struct sema *);
226 void os_sema_lock(struct sema *);
227 void os_sema_unlock(struct sema *);
229 int os_strlcpy(char *dst, char *src, int len);
230 void os_complete_outstanding_cmds_nodevice(pqisrc_softstate_t *);
231 void os_stop_heartbeat_timer(pqisrc_softstate_t *);
232 void os_start_heartbeat_timer(void *);
235 uint8_t os_get_task_attr(rcb_t *);
236 void os_wellness_periodic(void *);
237 void smartpqi_target_rescan(struct pqisrc_softstate *);
239 /* FreeBSD_intr.c FreeBSD_main.c */
240 void os_add_device(pqisrc_softstate_t *, pqi_scsi_dev_t *);
241 void os_remove_device(pqisrc_softstate_t *, pqi_scsi_dev_t *);
242 void os_io_response_success(rcb_t *);
243 void os_aio_response_error(rcb_t *, aio_path_error_info_elem_t *);
244 void smartpqi_adjust_queue_depth(struct cam_path *, uint32_t );
245 void os_raid_response_error(rcb_t *, raid_path_error_info_elem_t *);
246 void os_reset_rcb( rcb_t *);
247 int register_sim(struct pqisrc_softstate *, int);
248 void deregister_sim(struct pqisrc_softstate *);
249 int check_for_scsi_opcode(uint8_t *, boolean_t *, uint64_t *,
251 int register_legacy_intr(pqisrc_softstate_t *);
252 int register_msix_intr(pqisrc_softstate_t *);
253 void deregister_pqi_intx(pqisrc_softstate_t *);
254 void deregister_pqi_msix(pqisrc_softstate_t *);
255 void os_get_time(struct bmic_host_wellness_time *);
256 void os_eventtaskqueue_enqueue(pqisrc_softstate_t *);
257 void pqisrc_save_controller_info(struct pqisrc_softstate *);
258 int smartpqi_shutdown(void *);
260 #endif // _SMARTPQI_PROTOTYPES_H