xref: /freebsd/sys/dev/hpt27xx/himfuncs.h (revision 3078531de10dcae44b253a35125c949ff4235284)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2005-2011 HighPoint Technologies, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
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 #include <dev/hpt27xx/hpt27xx_config.h>
32 /*
33  * define _HIM_INTERFACE before include this file, and
34  * undef it after include this file.
35  */
36 
37 
38 #ifndef _HIM_INTERFACE
39 #error "you must define _HIM_INTERFACE before this file"
40 #endif
41 
42 _HIM_INTERFACE(HPT_BOOL, get_supported_device_id, (int index, PCI_ID *id))
43 
44 _HIM_INTERFACE(HPT_U8, get_controller_count, (PCI_ID *id, HPT_U8 *reached, PCI_ADDRESS *addr))
45 
46 
47 _HIM_INTERFACE(HPT_UINT, get_adapter_size, (const PCI_ID *id))
48 
49 
50 _HIM_INTERFACE(HPT_BOOL, create_adapter, (const PCI_ID *id, PCI_ADDRESS pciAddress, void *adapter, void *osext))
51 
52 _HIM_INTERFACE(void, get_adapter_config, (void *adapter, HIM_ADAPTER_CONFIG *config))
53 
54 _HIM_INTERFACE(HPT_BOOL, get_meminfo, (void *adapter))
55 
56 
57 _HIM_INTERFACE(HPT_BOOL, adapter_on_same_vbus, (void *adapter1, void *adapter2))
58 _HIM_INTERFACE(void, route_irq, (void *adapter, HPT_BOOL enable))
59 
60 
61 _HIM_INTERFACE(HPT_BOOL, initialize, (void *adapter))
62 
63 
64 _HIM_INTERFACE(HPT_UINT, get_device_size, (void *adapter))
65 
66 
67 _HIM_INTERFACE(HPT_BOOL, probe_device, (void *adapter, int index, void *devhandle, PROBE_CALLBACK done, void *arg))
68 _HIM_INTERFACE(void *, get_device, (void *adapter, int index))
69 _HIM_INTERFACE(void, get_device_config, (void *dev, HIM_DEVICE_CONFIG *config))
70 _HIM_INTERFACE(void, remove_device, (void *dev))
71 
72 _HIM_INTERFACE(void, reset_device, (void * dev, void (*done)(void *arg), void *arg))
73 
74 
75 _HIM_INTERFACE(HPT_U32, get_cmdext_size, (void))
76 
77 _HIM_INTERFACE(void, queue_cmd, (void *dev, struct _COMMAND *cmd))
78 
79 
80 _HIM_INTERFACE(int, read_write, (void *dev,HPT_LBA lba, HPT_U16 nsector, HPT_U8 *buffer, HPT_BOOL read))
81 
82 _HIM_INTERFACE(HPT_BOOL, intr_handler, (void *adapter))
83 _HIM_INTERFACE(HPT_BOOL, intr_control, (void * adapter, HPT_BOOL enable))
84 
85 
86 _HIM_INTERFACE(int, get_channel_config, (void * adapter, int index, PHIM_CHANNEL_CONFIG pInfo))
87 _HIM_INTERFACE(int, set_device_info, (void * dev, PHIM_ALTERABLE_DEV_INFO pInfo))
88 _HIM_INTERFACE(void, unplug_device, (void * dev))
89 
90 
91 _HIM_INTERFACE(void, shutdown, (void *adapter))
92 _HIM_INTERFACE(void, suspend, (void *adapter))
93 _HIM_INTERFACE(void, resume, (void *adapter))
94 _HIM_INTERFACE(void, release_adapter, (void *adapter))
95 
96 /*called after ldm_register_adapter*/
97 _HIM_INTERFACE(HPT_BOOL, verify_adapter, (void *adapter))
98 
99 /* (optional) */
100 _HIM_INTERFACE(void, ioctl, (void * adapter, struct _IOCTL_ARG *arg))
101 _HIM_INTERFACE(int, compare_slot_seq, (void *adapter1, void *adapter2))
102 _HIM_INTERFACE(int, get_enclosure_count, (void *adapter))
103 _HIM_INTERFACE(int, get_enclosure_info, (void *adapter, int id, void *pinfo))
104 _HIM_INTERFACE(int, get_enclosure_info_v2, (void *adapter, int id, void *pinfo))
105 _HIM_INTERFACE(int, get_enclosure_info_v3, (void *adapter, int id, void *pinfo))
106 _HIM_INTERFACE(int, get_enclosure_info_v4, (void *adapter, int enc_id, int ele_id, void *pinfo, void *pstatus))
107 
108 _HIM_INTERFACE(HPT_BOOL, flash_access, (void *adapter, HPT_U32 offset, void *value, int size, HPT_BOOL reading))
109 
110 #undef _HIM_INTERFACE
111