summaryrefslogtreecommitdiff
path: root/usr/src/uts/common/sys/fibre-channel/fca/oce/oce_utils.h
blob: a87cebff1509376c9c8baa95d607cb06cf1f713e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/* Copyright © 2003-2011 Emulex. All rights reserved.  */

/*
 * Driver Utility  function prototypes
 */

#ifndef _OCE_UTILS_H_
#define	_OCE_UTILS_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <sys/types.h>
#include <sys/list.h>

/* logging macro */
#define	MOD_CONFIG	0x0001
#define	MOD_TX		0x0002
#define	MOD_RX		0x0004
#define	MOD_ISR		0x0008

#define	OCE_DEFAULT_LOG_SETTINGS	(CE_WARN	|	\
					((MOD_CONFIG | MOD_TX | MOD_RX) << 16))

#define	OCE_MAX_LOG_SETTINGS		(CE_IGNORE | ((MOD_CONFIG | MOD_TX | \
					MOD_RX | MOD_ISR) << 16))

#define	oce_log(dev_p, level, module, fmt, arg...) {	\
	if (dev_p) {					\
		if ((dev_p->mod_mask & module) && 	\
		    (dev_p->severity < CE_IGNORE) && 	\
		    ((uint32_t)level >= dev_p->severity)) 	\
			cmn_err(level, "%s[%d]: " fmt, OCE_MOD_NAME,	\
			    dev_p->dev_id, ## arg);			\
	} else {							\
		cmn_err(level, "%s[%d]: " fmt, OCE_MOD_NAME,		\
		    0, ## arg);						\
	}								\
}


/* Time related */
#define	OCE_USDELAY(x) drv_usecwait((x))
#define	OCE_MSDELAY(x) OCE_USDELAY((x) * 1000)

/* Misc Macros */
#define	OCE_LOG2(x) (highbit((x)) - 1)
#define	ADDR_LO(addr) (uint32_t)BMASK_32(addr) /* low 32 bits */
#define	ADDR_HI(addr) (uint32_t)BMASK_32((addr >> 32)) /* high 32 bits */
#define	ADDR_64(_HI, _LO) ((uint64_t)(((uint64_t)(_HI) << 32)|(_LO)))
#define	voidptr(x)	(void *)((x))
#define	u32ptr(x)	(uint32_t *)voidptr((x))
#define	ptrtou32(x)	(uint32_t)((uint32_t *)(void *)(x))

#define	PAGE_4K		(0x1UL << 12)
#define	OFFSET_IN_4K_PAGE(addr) ((off_t)((uint64_t)addr & (PAGE_4K - 1)))
#define	OCE_NUM_PAGES(size) howmany(size, PAGE_4K)

#ifdef OCE_DEBUG
#define	OCE_DUMP(buf, len) { \
	int i = 0; \
	uint32_t *p = u32ptr(buf); \
	for (i = 0; i < len/4; i++) \
		cmn_err(CE_CONT, "[%d] 0x%x", i, p[i]); \
}
#endif

/* Utility Functions */

#define	OCE_DW_SWAP(datap, length)	{			\
	int len;	                                \
	uint32_t *wptr = (uint32_t *)(datap);                 \
	len = (length) + (((length)  %4) ? (4  - (4 %(length))) : 0); \
	for (len = len/4; len > 0; len--) {		\
		*wptr = LE_32(*wptr);			\
		wptr++;	                    \
	}							        \
}


#ifdef _BIG_ENDIAN
#define	DW_SWAP(_PTR, _LEN) OCE_DW_SWAP(_PTR, _LEN)
#else
#define	DW_SWAP(_PTR, _LEN)
#endif

typedef struct oce_list_entry {
	struct oce_list_entry *next;
	struct oce_list_entry *prev;
}OCE_LIST_NODE_T;

typedef struct {
	kmutex_t list_lock;
	OCE_LIST_NODE_T head;
	int32_t nitems;
}OCE_LIST_T;

/* externs for  list manipulation functions */


void oce_list_link_init(OCE_LIST_NODE_T  *list_node);
void oce_list_create(OCE_LIST_T  *list_hdr, void *arg);
void oce_list_destroy(OCE_LIST_T *list_hdr);
void oce_list_insert_tail(OCE_LIST_T *list_hdr, OCE_LIST_NODE_T *list_node);
void *oce_list_remove_head(OCE_LIST_T  *list_hdr);
void oce_list_remove_node(OCE_LIST_T  *list_hdr, OCE_LIST_NODE_T *list_node);
boolean_t oce_list_is_empty(OCE_LIST_T *list_hdr);
int32_t oce_list_items_avail(OCE_LIST_T *list_hdr);
int oce_atomic_reserve(uint32_t *count_p, uint32_t n);

#define	OCE_LIST_CREATE(_LH, _LCK_PRI)	oce_list_create((_LH), (_LCK_PRI))
#define	OCE_LIST_DESTROY(_LH)		oce_list_destroy((_LH))
#define	OCE_LIST_INSERT_TAIL(_LH, _N)				\
			oce_list_insert_tail((_LH), (void *)(_N))
#define	OCE_LIST_REM_HEAD(_LH)		oce_list_remove_head((_LH))
#define	OCE_LIST_EMPTY(_LH)		oce_list_is_empty((_LH))
#define	OCE_LIST_REMOVE(_LH, _N)				\
			oce_list_remove_node((_LH), (void *)(_N))
#define	OCE_LIST_SIZE(_LH)		oce_list_items_avail((_LH))
#define	OCE_LIST_LINK_INIT(_N)		oce_list_link_init(_N)

void oce_gen_hkey(char *hkey, int key_size);

#ifdef __cplusplus
}
#endif

#endif /* _OCE_UTILS_H_ */