spi: imx: do not access registers while clocks disabled
[platform/kernel/linux-starfive.git] / drivers / infiniband / hw / hns / hns_roce_hem.h
1 /*
2  * Copyright (c) 2016 Hisilicon Limited.
3  * Copyright (c) 2007, 2008 Mellanox Technologies. All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33
34 #ifndef _HNS_ROCE_HEM_H
35 #define _HNS_ROCE_HEM_H
36
37 #define HW_SYNC_TIMEOUT_MSECS           500
38 #define HW_SYNC_SLEEP_TIME_INTERVAL     20
39 #define BT_CMD_SYNC_SHIFT               31
40
41 enum {
42         /* MAP HEM(Hardware Entry Memory) */
43         HEM_TYPE_QPC = 0,
44         HEM_TYPE_MTPT,
45         HEM_TYPE_CQC,
46         HEM_TYPE_SRQC,
47
48          /* UNMAP HEM */
49         HEM_TYPE_MTT,
50         HEM_TYPE_CQE,
51         HEM_TYPE_IRRL,
52         HEM_TYPE_TRRL,
53 };
54
55 #define HNS_ROCE_HEM_CHUNK_LEN  \
56          ((256 - sizeof(struct list_head) - 2 * sizeof(int)) /   \
57          (sizeof(struct scatterlist)))
58
59 #define check_whether_bt_num_3(type, hop_num) \
60         (type < HEM_TYPE_MTT && hop_num == 2)
61
62 #define check_whether_bt_num_2(type, hop_num) \
63         ((type < HEM_TYPE_MTT && hop_num == 1) || \
64         (type >= HEM_TYPE_MTT && hop_num == 2))
65
66 #define check_whether_bt_num_1(type, hop_num) \
67         ((type < HEM_TYPE_MTT && hop_num == HNS_ROCE_HOP_NUM_0) || \
68         (type >= HEM_TYPE_MTT && hop_num == 1) || \
69         (type >= HEM_TYPE_MTT && hop_num == HNS_ROCE_HOP_NUM_0))
70
71 enum {
72          HNS_ROCE_HEM_PAGE_SHIFT = 12,
73          HNS_ROCE_HEM_PAGE_SIZE  = 1 << HNS_ROCE_HEM_PAGE_SHIFT,
74 };
75
76 struct hns_roce_hem_chunk {
77         struct list_head         list;
78         int                      npages;
79         int                      nsg;
80         struct scatterlist       mem[HNS_ROCE_HEM_CHUNK_LEN];
81 };
82
83 struct hns_roce_hem {
84         struct list_head         chunk_list;
85         int                      refcount;
86 };
87
88 struct hns_roce_hem_iter {
89         struct hns_roce_hem              *hem;
90         struct hns_roce_hem_chunk        *chunk;
91         int                              page_idx;
92 };
93
94 struct hns_roce_hem_mhop {
95         u32     hop_num;
96         u32     buf_chunk_size;
97         u32     bt_chunk_size;
98         u32     ba_l0_num;
99         u32     l0_idx;/* level 0 base address table index */
100         u32     l1_idx;/* level 1 base address table index */
101         u32     l2_idx;/* level 2 base address table index */
102 };
103
104 void hns_roce_free_hem(struct hns_roce_dev *hr_dev, struct hns_roce_hem *hem);
105 int hns_roce_table_get(struct hns_roce_dev *hr_dev,
106                        struct hns_roce_hem_table *table, unsigned long obj);
107 void hns_roce_table_put(struct hns_roce_dev *hr_dev,
108                         struct hns_roce_hem_table *table, unsigned long obj);
109 void *hns_roce_table_find(struct hns_roce_dev *hr_dev,
110                           struct hns_roce_hem_table *table, unsigned long obj,
111                           dma_addr_t *dma_handle);
112 int hns_roce_table_get_range(struct hns_roce_dev *hr_dev,
113                              struct hns_roce_hem_table *table,
114                              unsigned long start, unsigned long end);
115 void hns_roce_table_put_range(struct hns_roce_dev *hr_dev,
116                               struct hns_roce_hem_table *table,
117                               unsigned long start, unsigned long end);
118 int hns_roce_init_hem_table(struct hns_roce_dev *hr_dev,
119                             struct hns_roce_hem_table *table, u32 type,
120                             unsigned long obj_size, unsigned long nobj,
121                             int use_lowmem);
122 void hns_roce_cleanup_hem_table(struct hns_roce_dev *hr_dev,
123                                 struct hns_roce_hem_table *table);
124 void hns_roce_cleanup_hem(struct hns_roce_dev *hr_dev);
125 int hns_roce_calc_hem_mhop(struct hns_roce_dev *hr_dev,
126                            struct hns_roce_hem_table *table, unsigned long *obj,
127                            struct hns_roce_hem_mhop *mhop);
128 bool hns_roce_check_whether_mhop(struct hns_roce_dev *hr_dev, u32 type);
129
130 static inline void hns_roce_hem_first(struct hns_roce_hem *hem,
131                                       struct hns_roce_hem_iter *iter)
132 {
133         iter->hem = hem;
134         iter->chunk = list_empty(&hem->chunk_list) ? NULL :
135                                  list_entry(hem->chunk_list.next,
136                                             struct hns_roce_hem_chunk, list);
137         iter->page_idx = 0;
138 }
139
140 static inline int hns_roce_hem_last(struct hns_roce_hem_iter *iter)
141 {
142         return !iter->chunk;
143 }
144
145 static inline void hns_roce_hem_next(struct hns_roce_hem_iter *iter)
146 {
147         if (++iter->page_idx >= iter->chunk->nsg) {
148                 if (iter->chunk->list.next == &iter->hem->chunk_list) {
149                         iter->chunk = NULL;
150                         return;
151                 }
152
153                 iter->chunk = list_entry(iter->chunk->list.next,
154                                          struct hns_roce_hem_chunk, list);
155                 iter->page_idx = 0;
156         }
157 }
158
159 static inline dma_addr_t hns_roce_hem_addr(struct hns_roce_hem_iter *iter)
160 {
161         return sg_dma_address(&iter->chunk->mem[iter->page_idx]);
162 }
163
164 #endif /*_HNS_ROCE_HEM_H*/