1/*-
2 * Copyright (c) 2002-2007 Neterion, 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: releng/10.2/sys/dev/nxge/include/xgehal-event.h 173139 2007-10-29 14:19:32Z rwatson $
27 */
28
29#ifndef XGE_HAL_EVENT_H
30#define XGE_HAL_EVENT_H
31
32#include <dev/nxge/include/xge-os-pal.h>
33
34__EXTERN_BEGIN_DECLS
35
36#define XGE_HAL_EVENT_BASE      0
37#define XGE_LL_EVENT_BASE       100
38
39/**
40 * enum xge_hal_event_e - Enumerates slow-path HAL events.
41 * @XGE_HAL_EVENT_UNKNOWN: Unknown (and invalid) event.
42 * @XGE_HAL_EVENT_SERR: Serious hardware error event.
43 * @XGE_HAL_EVENT_LINK_IS_UP: The link state has changed from 'down' to
44 * 'up'; upper-layer driver (typically, link layer) is
45 * supposed to wake the queue, etc.
46 * @XGE_HAL_EVENT_LINK_IS_DOWN: Link-down event.
47 *                    The link state has changed from 'down' to 'up';
48 *                    upper-layer driver is supposed to stop traffic, etc.
49 * @XGE_HAL_EVENT_ECCERR: ECC error event.
50 * @XGE_HAL_EVENT_PARITYERR: Parity error event.
51 * @XGE_HAL_EVENT_TARGETABORT: Target abort event. Used when device
52 * aborts transmit operation with the corresponding transfer code
53 * (for T_CODE enum see xgehal-fifo.h and xgehal-ring.h)
54 * @XGE_HAL_EVENT_SLOT_FREEZE: Slot-freeze event. Driver tries to distinguish
55 * slot-freeze from the rest critical events (e.g. ECC) when it is
56 * impossible to PIO read "through" the bus, i.e. when getting all-foxes.
57 *
58 * xge_hal_event_e enumerates slow-path HAL eventis.
59 *
60 * See also: xge_hal_uld_cbs_t{}, xge_uld_link_up_f{},
61 * xge_uld_link_down_f{}.
62 */
63typedef enum xge_hal_event_e {
64	XGE_HAL_EVENT_UNKNOWN       = 0,
65	/* HAL events */
66	XGE_HAL_EVENT_SERR          = XGE_HAL_EVENT_BASE + 1,
67	XGE_HAL_EVENT_LINK_IS_UP    = XGE_HAL_EVENT_BASE + 2,
68	XGE_HAL_EVENT_LINK_IS_DOWN  = XGE_HAL_EVENT_BASE + 3,
69	XGE_HAL_EVENT_ECCERR        = XGE_HAL_EVENT_BASE + 4,
70	XGE_HAL_EVENT_PARITYERR     = XGE_HAL_EVENT_BASE + 5,
71	XGE_HAL_EVENT_TARGETABORT   = XGE_HAL_EVENT_BASE + 6,
72	XGE_HAL_EVENT_SLOT_FREEZE   = XGE_HAL_EVENT_BASE + 7,
73} xge_hal_event_e;
74
75__EXTERN_END_DECLS
76
77#endif /* XGE_HAL_EVENT_H */
78