1 /*
2  * This file is part of the Chelsio FCoE driver for Linux.
3  *
4  * Copyright (c) 2008-2012 Chelsio Communications, Inc. All rights reserved.
5  *
6  * This software is available to you under a choice of one of two
7  * licenses.  You may choose to be licensed under the terms of the GNU
8  * General Public License (GPL) Version 2, available from the file
9  * COPYING in the main directory of this source tree, or the
10  * OpenIB.org BSD license below:
11  *
12  *     Redistribution and use in source and binary forms, with or
13  *     without modification, are permitted provided that the following
14  *     conditions are met:
15  *
16  *      - Redistributions of source code must retain the above
17  *        copyright notice, this list of conditions and the following
18  *        disclaimer.
19  *
20  *      - Redistributions in binary form must reproduce the above
21  *        copyright notice, this list of conditions and the following
22  *        disclaimer in the documentation and/or other materials
23  *        provided with the distribution.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32  * SOFTWARE.
33  */
34 
35 #ifndef __CSIO_DEFS_H__
36 #define __CSIO_DEFS_H__
37 
38 #include <linux/kernel.h>
39 #include <linux/stddef.h>
40 #include <linux/timer.h>
41 #include <linux/list.h>
42 #include <linux/bug.h>
43 #include <linux/pci.h>
44 #include <linux/jiffies.h>
45 
46 #define CSIO_INVALID_IDX		0xFFFFFFFF
47 #define CSIO_INC_STATS(elem, val)	((elem)->stats.val++)
48 #define CSIO_DEC_STATS(elem, val)	((elem)->stats.val--)
49 #define CSIO_VALID_WWN(__n)		((*__n >> 4) == 0x5 ? true : false)
50 #define CSIO_DID_MASK			0xFFFFFF
51 #define CSIO_WORD_TO_BYTE		4
52 
53 #ifndef readq
54 static inline u64 readq(void __iomem *addr)
55 {
56 	return readl(addr) + ((u64)readl(addr + 4) << 32);
57 }
58 
59 static inline void writeq(u64 val, void __iomem *addr)
60 {
61 	writel(val, addr);
62 	writel(val >> 32, addr + 4);
63 }
64 #endif
65 
66 static inline int
67 csio_list_deleted(struct list_head *list)
68 {
69 	return ((list->next == list) && (list->prev == list));
70 }
71 
72 #define csio_list_next(elem)	(((struct list_head *)(elem))->next)
73 #define csio_list_prev(elem)	(((struct list_head *)(elem))->prev)
74 
75 /* State machine */
76 typedef void (*csio_sm_state_t)(void *, uint32_t);
77 
78 struct csio_sm {
79 	struct list_head	sm_list;
80 	csio_sm_state_t		sm_state;
81 };
82 
83 static inline void
84 csio_set_state(void *smp, void *state)
85 {
86 	((struct csio_sm *)smp)->sm_state = (csio_sm_state_t)state;
87 }
88 
89 static inline void
90 csio_init_state(struct csio_sm *smp, void *state)
91 {
92 	csio_set_state(smp, state);
93 }
94 
95 static inline void
96 csio_post_event(void *smp, uint32_t evt)
97 {
98 	((struct csio_sm *)smp)->sm_state(smp, evt);
99 }
100 
101 static inline csio_sm_state_t
102 csio_get_state(void *smp)
103 {
104 	return ((struct csio_sm *)smp)->sm_state;
105 }
106 
107 static inline bool
108 csio_match_state(void *smp, void *state)
109 {
110 	return (csio_get_state(smp) == (csio_sm_state_t)state);
111 }
112 
113 #define	CSIO_ASSERT(cond)		BUG_ON(!(cond))
114 
115 #ifdef __CSIO_DEBUG__
116 #define CSIO_DB_ASSERT(__c)		CSIO_ASSERT((__c))
117 #else
118 #define CSIO_DB_ASSERT(__c)
119 #endif
120 
121 #endif /* ifndef __CSIO_DEFS_H__ */
122