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