xref: /freebsd/sys/dev/hptnr/himfuncs.h (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
1 /* $Id: himfuncs.h,v 1.17 2010/05/10 10:10:02 lcn Exp $ */
2 /*-
3  * SPDX-License-Identifier: BSD-2-Clause
4  *
5  * Copyright (C) 2005-2011 HighPoint Technologies, Inc.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 /*
30  * define _HIM_INTERFACE before include this file, and
31  * undef it after include this file.
32  */
33 
34 #include <dev/hptnr/hptnr_config.h>
35 
36 #ifndef _HIM_INTERFACE
37 #error "you must define _HIM_INTERFACE before this file"
38 #endif
39 
40 _HIM_INTERFACE(HPT_BOOL, get_supported_device_id, (int index, PCI_ID *id))
41 
42 _HIM_INTERFACE(HPT_U8, get_controller_count, (PCI_ID *id, HPT_U8 *reached, PCI_ADDRESS *addr))
43 
44 
45 _HIM_INTERFACE(HPT_UINT, get_adapter_size, (const PCI_ID *id))
46 
47 
48 _HIM_INTERFACE(HPT_BOOL, create_adapter, (const PCI_ID *id, PCI_ADDRESS pciAddress, void *adapter, void *osext))
49 
50 _HIM_INTERFACE(void, get_adapter_config, (void *adapter, HIM_ADAPTER_CONFIG *config))
51 
52 _HIM_INTERFACE(HPT_BOOL, get_meminfo, (void *adapter))
53 
54 
55 _HIM_INTERFACE(HPT_BOOL, adapter_on_same_vbus, (void *adapter1, void *adapter2))
56 _HIM_INTERFACE(void, route_irq, (void *adapter, HPT_BOOL enable))
57 
58 
59 _HIM_INTERFACE(HPT_BOOL, initialize, (void *adapter))
60 
61 
62 _HIM_INTERFACE(HPT_UINT, get_device_size, (void *adapter))
63 
64 
65 _HIM_INTERFACE(HPT_BOOL, probe_device, (void *adapter, int index, void *devhandle, PROBE_CALLBACK done, void *arg))
66 _HIM_INTERFACE(void *, get_device, (void *adapter, int index))
67 _HIM_INTERFACE(void, get_device_config, (void *dev, HIM_DEVICE_CONFIG *config))
68 _HIM_INTERFACE(void, remove_device, (void *dev))
69 
70 _HIM_INTERFACE(void, reset_device, (void * dev, void (*done)(void *arg), void *arg))
71 
72 
73 _HIM_INTERFACE(HPT_U32, get_cmdext_size, (void))
74 
75 _HIM_INTERFACE(void, queue_cmd, (void *dev, struct _COMMAND *cmd))
76 
77 
78 _HIM_INTERFACE(int, read_write, (void *dev,HPT_LBA lba, HPT_U16 nsector, HPT_U8 *buffer, HPT_BOOL read))
79 
80 _HIM_INTERFACE(HPT_BOOL, intr_handler, (void *adapter))
81 _HIM_INTERFACE(HPT_BOOL, intr_control, (void * adapter, HPT_BOOL enable))
82 
83 
84 _HIM_INTERFACE(int, get_channel_config, (void * adapter, int index, PHIM_CHANNEL_CONFIG pInfo))
85 _HIM_INTERFACE(int, set_device_info, (void * dev, PHIM_ALTERABLE_DEV_INFO pInfo))
86 _HIM_INTERFACE(void, unplug_device, (void * dev))
87 
88 
89 _HIM_INTERFACE(void, shutdown, (void *adapter))
90 _HIM_INTERFACE(void, suspend, (void *adapter))
91 _HIM_INTERFACE(void, resume, (void *adapter))
92 _HIM_INTERFACE(void, release_adapter, (void *adapter))
93 
94 /*called after ldm_register_adapter*/
95 _HIM_INTERFACE(HPT_BOOL, verify_adapter, (void *adapter))
96 
97 /* (optional) */
98 _HIM_INTERFACE(void, ioctl, (void * adapter, struct _IOCTL_ARG *arg))
99 _HIM_INTERFACE(int, compare_slot_seq, (void *adapter1, void *adapter2))
100 _HIM_INTERFACE(int, get_enclosure_count, (void *adapter))
101 _HIM_INTERFACE(int, get_enclosure_info, (void *adapter, int id, void *pinfo))
102 _HIM_INTERFACE(int, get_enclosure_info_v2, (void *adapter, int id, void *pinfo))
103 _HIM_INTERFACE(int, get_enclosure_info_v3, (void *adapter, int id, void *pinfo))
104 _HIM_INTERFACE(int, get_enclosure_info_v4, (void *adapter, int enc_id, int ele_id, void *pinfo, void *pstatus))
105 
106 _HIM_INTERFACE(HPT_BOOL, flash_access, (void *adapter, HPT_U32 offset, void *value, int size, HPT_BOOL reading))
107 
108 #undef _HIM_INTERFACE
109