xref: /freebsd/sys/dev/hptrr/himfuncs.h (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
1 /*
2  * Copyright (c) HighPoint Technologies, Inc.
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  *
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
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 #include <dev/hptrr/hptrr_config.h>
29 /* $Id: himfuncs.h,v 1.14 2005/12/22 00:13:11 gmm Exp $
30  * Copyright (C) 2004-2005 HighPoint Technologies, Inc. All rights reserved.
31  *
32  * define _HIM_INTERFACE before include this file, and
33  * undef it after include this file.
34  */
35 
36 
37 #ifndef _HIM_INTERFACE
38 #error "you must define _HIM_INTERFACE before this file"
39 #endif
40 
41 _HIM_INTERFACE(HPT_BOOL, get_supported_device_id, (int index, PCI_ID *id))
42 
43 _HIM_INTERFACE(HPT_U8, get_controller_count, (PCI_ID *id, HPT_U8 *reached))
44 
45 
46 _HIM_INTERFACE(HPT_UINT, get_adapter_size, (const PCI_ID *id))
47 
48 
49 _HIM_INTERFACE(HPT_BOOL, create_adapter, (const PCI_ID *id, PCI_ADDRESS pciAddress, void *adapter, void *osext))
50 
51 _HIM_INTERFACE(void, get_adapter_config, (void *adapter, HIM_ADAPTER_CONFIG *config))
52 
53 _HIM_INTERFACE(HPT_BOOL, get_meminfo, (void *adapter))
54 
55 
56 _HIM_INTERFACE(HPT_BOOL, adapter_on_same_vbus, (void *adapter1, void *adapter2))
57 _HIM_INTERFACE(void, route_irq, (void *adapter, HPT_BOOL enable))
58 
59 
60 _HIM_INTERFACE(HPT_BOOL, initialize, (void *adapter))
61 
62 
63 _HIM_INTERFACE(HPT_UINT, get_device_size, (void *adapter))
64 
65 
66 _HIM_INTERFACE(HPT_BOOL, probe_device, (void *adapter, int index, void *devhandle, PROBE_CALLBACK done, void *arg))
67 _HIM_INTERFACE(void *, get_device, (void *adapter, int index))
68 _HIM_INTERFACE(void, get_device_config, (void *dev, HIM_DEVICE_CONFIG *config))
69 _HIM_INTERFACE(void, remove_device, (void *dev))
70 
71 _HIM_INTERFACE(void, reset_device, (void * dev, void (*done)(void *arg), void *arg))
72 
73 
74 _HIM_INTERFACE(HPT_U32, get_cmdext_size, (void))
75 
76 _HIM_INTERFACE(void, queue_cmd, (void *dev, struct _COMMAND *cmd))
77 
78 
79 _HIM_INTERFACE(int, read_write, (void *dev,HPT_LBA lba, HPT_U16 nsector, HPT_U8 *buffer, HPT_BOOL read))
80 
81 _HIM_INTERFACE(HPT_BOOL, intr_handler, (void *adapter))
82 _HIM_INTERFACE(HPT_BOOL, intr_control, (void * adapter, HPT_BOOL enable))
83 
84 
85 _HIM_INTERFACE(int, get_channel_config, (void * adapter, int index, PHIM_CHANNEL_CONFIG pInfo))
86 _HIM_INTERFACE(int, set_device_info, (void * dev, PHIM_ALTERABLE_DEV_INFO pInfo))
87 _HIM_INTERFACE(void, unplug_device, (void * dev))
88 
89 
90 _HIM_INTERFACE(void, shutdown, (void *adapter))
91 _HIM_INTERFACE(void, suspend, (void *adapter))
92 _HIM_INTERFACE(void, resume, (void *adapter))
93 _HIM_INTERFACE(void, release_adapter, (void *adapter))
94 
95 /*called after ldm_register_adapter*/
96 _HIM_INTERFACE(HPT_BOOL, verify_adapter, (void *adapter))
97 
98 /* (optional) */
99 _HIM_INTERFACE(void, ioctl, (void * adapter, struct _IOCTL_ARG *arg))
100 _HIM_INTERFACE(int, compare_slot_seq, (void *adapter1, void *adapter2))
101 
102 
103 _HIM_INTERFACE(HPT_BOOL, flash_access, (void *adapter, HPT_U32 offset, void *value, int size, HPT_BOOL reading))
104 
105 #undef _HIM_INTERFACE
106