1/*-
2 * Copyright(c) 2002-2011 Exar Corp.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification are permitted provided the following conditions are met:
7 *
8 *    1. Redistributions of source code must retain the above copyright notice,
9 *       this list of conditions and the following disclaimer.
10 *
11 *    2. Redistributions in binary form must reproduce the above copyright
12 *       notice, this list of conditions and the following disclaimer in the
13 *       documentation and/or other materials provided with the distribution.
14 *
15 *    3. Neither the name of the Exar Corporation nor the names of its
16 *       contributors may be used to endorse or promote products derived from
17 *       this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31/*$FreeBSD$*/
32
33#ifndef	VXGE_HAL_DRIVER_H
34#define	VXGE_HAL_DRIVER_H
35
36__EXTERN_BEGIN_DECLS
37
38/* maximum number of events consumed in a syncle poll() cycle */
39#define	VXGE_HAL_DRIVER_QUEUE_CONSUME_MAX	5
40
41/*
42 * struct __hal_driver_t - Represents HAL object for driver.
43 * @config: HAL configuration.
44 * @devices: List of all PCI-enumerated X3100 devices in the system.
45 * A single vxge_hal_driver_t instance contains zero or more
46 * X3100 devices.
47 * @devices_lock: Lock to protect %devices when inserting/removing.
48 * @is_initialized: True if HAL is initialized; false otherwise.
49 * @uld_callbacks: Upper-layer driver callbacks. See vxge_hal_uld_cbs_t {}.
50 * @debug_module_mask: 32bit mask that defines which components of the
51 * driver are to be traced. The trace-able components are listed in
52 * xgehal_debug.h:
53 * @debug_level: See vxge_debug_level_e {}.
54 *
55 * HAL (driver) object. There is a single instance of this structure per HAL.
56 */
57typedef struct __hal_driver_t {
58	vxge_hal_driver_config_t	config;
59	int				is_initialized;
60	vxge_hal_uld_cbs_t		uld_callbacks;
61	u32				debug_level;
62} __hal_driver_t;
63
64extern __hal_driver_t *g_vxge_hal_driver;
65
66__EXTERN_END_DECLS
67
68#endif	/* VXGE_HAL_DRIVER_H */
69