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