msgring.h revision 202173
1/*-
2 * Copyright (c) 2003-2009 RMI Corporation
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 * 3. Neither the name of RMI Corporation, nor the names of its contributors,
14 *    may be used to endorse or promote products derived from this software
15 *    without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * RMI_BSD */
30#ifndef _RMI_MSGRING_H_
31#define _RMI_MSGRING_H_
32
33#include <mips/rmi/xlrconfig.h>
34
35#define MSGRNG_TX_BUF_REG 0
36#define MSGRNG_RX_BUF_REG 1
37
38#define MSGRNG_MSG_STATUS_REG 2
39#define MSGRNG_MSG_CONFIG_REG 3
40
41#define MSGRNG_MSG_BUCKSIZE_REG 4
42
43#define MSGRNG_CC_0_REG  16
44#define MSGRNG_CC_1_REG  17
45#define MSGRNG_CC_2_REG  18
46#define MSGRNG_CC_3_REG  19
47#define MSGRNG_CC_4_REG  20
48#define MSGRNG_CC_5_REG  21
49#define MSGRNG_CC_6_REG  22
50#define MSGRNG_CC_7_REG  23
51#define MSGRNG_CC_8_REG  24
52#define MSGRNG_CC_9_REG  25
53#define MSGRNG_CC_10_REG 26
54#define MSGRNG_CC_11_REG 27
55#define MSGRNG_CC_12_REG 28
56#define MSGRNG_CC_13_REG 29
57#define MSGRNG_CC_14_REG 30
58#define MSGRNG_CC_15_REG 31
59
60#define msgrng_read_status() read_c2_register32(MSGRNG_MSG_STATUS_REG, 0)
61
62#define msgrng_read_config() read_c2_register32(MSGRNG_MSG_CONFIG_REG, 0)
63#define msgrng_write_config(value) write_c2_register32(MSGRNG_MSG_CONFIG_REG, 0, value)
64
65#define msgrng_read_bucksize(bucket) read_c2_register32(MSGRNG_MSG_BUCKSIZE_REG, bucket)
66#define msgrng_write_bucksize(bucket, value) write_c2_register32(MSGRNG_MSG_BUCKSIZE_REG, bucket, value)
67
68#define msgrng_read_cc(reg, pri) read_c2_register32(reg, pri)
69#define msgrng_write_cc(reg, value, pri) write_c2_register32(reg, pri, value)
70
71#define msgrng_load_rx_msg0() read_c2_register64(MSGRNG_RX_BUF_REG, 0)
72#define msgrng_load_rx_msg1() read_c2_register64(MSGRNG_RX_BUF_REG, 1)
73#define msgrng_load_rx_msg2() read_c2_register64(MSGRNG_RX_BUF_REG, 2)
74#define msgrng_load_rx_msg3() read_c2_register64(MSGRNG_RX_BUF_REG, 3)
75
76#define msgrng_load_tx_msg0(value) write_c2_register64(MSGRNG_TX_BUF_REG, 0, value)
77#define msgrng_load_tx_msg1(value) write_c2_register64(MSGRNG_TX_BUF_REG, 1, value)
78#define msgrng_load_tx_msg2(value) write_c2_register64(MSGRNG_TX_BUF_REG, 2, value)
79#define msgrng_load_tx_msg3(value) write_c2_register64(MSGRNG_TX_BUF_REG, 3, value)
80
81/* Station IDs */
82#define MSGRNG_STNID_CPU0  0x00
83#define MSGRNG_STNID_CPU1  0x08
84#define MSGRNG_STNID_CPU2  0x10
85#define MSGRNG_STNID_CPU3  0x18
86#define MSGRNG_STNID_CPU4  0x20
87#define MSGRNG_STNID_CPU5  0x28
88#define MSGRNG_STNID_CPU6  0x30
89#define MSGRNG_STNID_CPU7  0x38
90#define MSGRNG_STNID_XGS0_TX 64
91#define MSGRNG_STNID_XMAC0_00_TX 64
92#define MSGRNG_STNID_XMAC0_01_TX 65
93#define MSGRNG_STNID_XMAC0_02_TX 66
94#define MSGRNG_STNID_XMAC0_03_TX 67
95#define MSGRNG_STNID_XMAC0_04_TX 68
96#define MSGRNG_STNID_XMAC0_05_TX 69
97#define MSGRNG_STNID_XMAC0_06_TX 70
98#define MSGRNG_STNID_XMAC0_07_TX 71
99#define MSGRNG_STNID_XMAC0_08_TX 72
100#define MSGRNG_STNID_XMAC0_09_TX 73
101#define MSGRNG_STNID_XMAC0_10_TX 74
102#define MSGRNG_STNID_XMAC0_11_TX 75
103#define MSGRNG_STNID_XMAC0_12_TX 76
104#define MSGRNG_STNID_XMAC0_13_TX 77
105#define MSGRNG_STNID_XMAC0_14_TX 78
106#define MSGRNG_STNID_XMAC0_15_TX 79
107
108#define MSGRNG_STNID_XGS1_TX 80
109#define MSGRNG_STNID_XMAC1_00_TX 80
110#define MSGRNG_STNID_XMAC1_01_TX 81
111#define MSGRNG_STNID_XMAC1_02_TX 82
112#define MSGRNG_STNID_XMAC1_03_TX 83
113#define MSGRNG_STNID_XMAC1_04_TX 84
114#define MSGRNG_STNID_XMAC1_05_TX 85
115#define MSGRNG_STNID_XMAC1_06_TX 86
116#define MSGRNG_STNID_XMAC1_07_TX 87
117#define MSGRNG_STNID_XMAC1_08_TX 88
118#define MSGRNG_STNID_XMAC1_09_TX 89
119#define MSGRNG_STNID_XMAC1_10_TX 90
120#define MSGRNG_STNID_XMAC1_11_TX 91
121#define MSGRNG_STNID_XMAC1_12_TX 92
122#define MSGRNG_STNID_XMAC1_13_TX 93
123#define MSGRNG_STNID_XMAC1_14_TX 94
124#define MSGRNG_STNID_XMAC1_15_TX 95
125
126#define MSGRNG_STNID_GMAC 96
127#define MSGRNG_STNID_GMACJFR_0  96
128#define MSGRNG_STNID_GMACRFR_0  97
129#define MSGRNG_STNID_GMACTX0    98
130#define MSGRNG_STNID_GMACTX1    99
131#define MSGRNG_STNID_GMACTX2    100
132#define MSGRNG_STNID_GMACTX3    101
133#define MSGRNG_STNID_GMACJFR_1  102
134#define MSGRNG_STNID_GMACRFR_1  103
135
136#define MSGRNG_STNID_DMA      104
137#define MSGRNG_STNID_DMA_0    104
138#define MSGRNG_STNID_DMA_1    105
139#define MSGRNG_STNID_DMA_2    106
140#define MSGRNG_STNID_DMA_3    107
141
142#define MSGRNG_STNID_XGS0FR 112
143#define MSGRNG_STNID_XMAC0JFR 112
144#define MSGRNG_STNID_XMAC0RFR 113
145
146#define MSGRNG_STNID_XGS1FR 114
147#define MSGRNG_STNID_XMAC1JFR 114
148#define MSGRNG_STNID_XMAC1RFR 115
149#define MSGRNG_STNID_SEC 120
150#define MSGRNG_STNID_SEC0 120
151#define MSGRNG_STNID_SEC1 121
152#define MSGRNG_STNID_SEC2 122
153#define MSGRNG_STNID_SEC3 123
154#define MSGRNG_STNID_PK0  124
155#define MSGRNG_STNID_SEC_RSA 124
156#define MSGRNG_STNID_SEC_RSVD0 125
157#define MSGRNG_STNID_SEC_RSVD1 126
158#define MSGRNG_STNID_SEC_RSVD2 127
159
160#define MSGRNG_STNID_GMAC1      80
161#define MSGRNG_STNID_GMAC1_FR_0   81
162#define MSGRNG_STNID_GMAC1_TX0  82
163#define MSGRNG_STNID_GMAC1_TX1  83
164#define MSGRNG_STNID_GMAC1_TX2  84
165#define MSGRNG_STNID_GMAC1_TX3  85
166#define MSGRNG_STNID_GMAC1_FR_1   87
167#define MSGRNG_STNID_GMAC0      96
168#define MSGRNG_STNID_GMAC0_FR_0   97
169#define MSGRNG_STNID_GMAC0_TX0  98
170#define MSGRNG_STNID_GMAC0_TX1  99
171#define MSGRNG_STNID_GMAC0_TX2  100
172#define MSGRNG_STNID_GMAC0_TX3  101
173#define MSGRNG_STNID_GMAC0_FR_1   103
174#define MSGRNG_STNID_CMP_0      108
175#define MSGRNG_STNID_CMP_1      109
176#define MSGRNG_STNID_CMP_2      110
177#define MSGRNG_STNID_CMP_3      111
178#define MSGRNG_STNID_PCIE_0     116
179#define MSGRNG_STNID_PCIE_1     117
180#define MSGRNG_STNID_PCIE_2     118
181#define MSGRNG_STNID_PCIE_3     119
182#define MSGRNG_STNID_XLS_PK0    121
183
184#define MSGRNG_CODE_MAC 0
185#define MSGRNG_CODE_XGMAC 2
186#define MSGRNG_CODE_SEC 0
187#define MSGRNG_CODE_BOOT_WAKEUP 200
188#define MSGRNG_CODE_SPI4 3
189
190static inline int
191msgrng_xgmac_stid_rfr(int id)
192{
193	return !id ? MSGRNG_STNID_XMAC0RFR : MSGRNG_STNID_XMAC1RFR;
194}
195
196static inline int
197msgrng_xgmac_stid_jfr(int id)
198{
199	return !id ? MSGRNG_STNID_XMAC0JFR : MSGRNG_STNID_XMAC1JFR;
200}
201
202static inline int
203msgrng_xgmac_stid_tx(int id)
204{
205	return !id ? MSGRNG_STNID_XMAC0_00_TX : MSGRNG_STNID_XMAC1_00_TX;
206}
207
208static inline int
209msgrng_gmac_stid_rfr(int id)
210{
211	return (MSGRNG_STNID_GMACRFR_0);
212}
213
214static inline int
215msgrng_gmac_stid_rfr_split_mode(int id)
216{
217	return ((id >> 1) ? MSGRNG_STNID_GMACRFR_1 : MSGRNG_STNID_GMACRFR_0);
218}
219
220static inline int
221msgrng_gmac_stid_jfr(int id)
222{
223	return MSGRNG_STNID_GMACJFR_0;
224}
225
226static inline int
227msgrng_gmac_stid_jfr_split_mode(int id)
228{
229	return ((id >> 1) ? MSGRNG_STNID_GMACJFR_1 : MSGRNG_STNID_GMACJFR_0);
230}
231
232static inline int
233msgrng_gmac_stid_tx(int id)
234{
235	return (MSGRNG_STNID_GMACTX0 + id);
236}
237
238static inline void
239msgrng_send(unsigned int stid)
240{
241	__asm__ volatile (
242	             ".set push\n"
243	             ".set noreorder\n"
244	             "sync\n"
245	    //       "msgsnd %0\n"
246	             "move  $8, %0\n"
247	             "c2    0x80001\n"
248	             ".set pop\n"
249	    ::       "r" (stid):"$8"
250	);
251}
252
253static inline void
254msgrng_receive(unsigned int pri)
255{
256	__asm__ volatile (
257	             ".set push\n"
258	             ".set noreorder\n"
259	    //       "msgld %0\n"
260	             "move $8, %0\n"
261	             "c2   0x80002\n"
262	             ".set pop\n"
263	    ::       "r" (pri):"$8"
264	);
265}
266static inline void
267msgrng_wait(unsigned int mask)
268{
269	__asm__ volatile (
270	             ".set push\n"
271	             ".set noreorder\n"
272	    //       "msgwait %0\n"
273	             "move $8, %0\n"
274	             "c2   0x80003\n"
275	             ".set pop\n"
276	    ::       "r" (mask):"$8"
277	);
278}
279
280#define msgrng_enable(flags)                        \
281do {                                                \
282  __asm__ volatile (                                \
283		    ".set push\n\t"                 \
284		    ".set reorder\n\t"              \
285		    ".set noat\n\t"                 \
286		    "mfc0 %0, $12\n\t"              \
287		    "li  $8, 0x40000001\n\t"        \
288		    "or  $1, %0, $8\n\t"            \
289		    "xori $1, 1\n\t"                \
290		    ".set noreorder\n\t"            \
291		    "mtc0 $1, $12\n\t"              \
292		    ".set\tpop\n\t"                 \
293		    : "=r" (flags)                  \
294		    :                               \
295		    : "$8"                          \
296		    );                              \
297} while (0)
298
299#define msgrng_disable(flags) __asm__ volatile (    \
300                 "mtc0 %0, $12" : : "r" (flags))
301
302#define msgrng_flags_save(flags) msgrng_enable(flags)
303#define msgrng_flags_restore(flags) msgrng_disable(flags)
304
305struct msgrng_msg {
306	__uint64_t msg0;
307	__uint64_t msg1;
308	__uint64_t msg2;
309	__uint64_t msg3;
310};
311
312static inline void
313message_send_block_fast(int size, unsigned int code, unsigned int stid,
314    unsigned long long msg0, unsigned long long msg1,
315    unsigned long long msg2, unsigned long long msg3)
316{
317	__asm__ __volatile__(".set push\n"
318	            ".set noreorder\n"
319	            ".set mips64\n"
320	            "dmtc2 %1, $0, 0\n"
321	            "dmtc2 %2, $0, 1\n"
322	            "dmtc2 %3, $0, 2\n"
323	            "dmtc2 %4, $0, 3\n"
324	            "move $8, %0\n"
325	            "1: c2 0x80001\n"
326	            "mfc2 $8, $2\n"
327	            "andi $8, $8, 0x6\n"
328	            "bnez $8, 1b\n"
329	            "move $8, %0\n"
330	            ".set pop\n"
331	    :
332	    :       "r"(((size - 1) << 16) | (code << 8) | stid), "r"(msg0), "r"(msg1), "r"(msg2), "r"(msg3)
333	    :       "$8"
334	);
335}
336
337#define message_receive_fast(bucket, size, code, stid, msg0, msg1, msg2, msg3)      \
338        ( { unsigned int _status=0, _tmp=0;                     \
339           msgrng_receive(bucket);                              \
340           while ( (_status=msgrng_read_status()) & 0x08) ;     \
341           _tmp = _status & 0x30;                               \
342           if (__builtin_expect((!_tmp), 1)) {                  \
343                 (size)=((_status & 0xc0)>>6)+1;                \
344                 (code)=(_status & 0xff00)>>8;                  \
345                 (stid)=(_status & 0x7f0000)>>16;               \
346                 (msg0)=msgrng_load_rx_msg0();                  \
347                 (msg1)=msgrng_load_rx_msg1();                  \
348                 (msg2)=msgrng_load_rx_msg2();                  \
349                 (msg3)=msgrng_load_rx_msg3();                  \
350                 _tmp=0;                                        \
351                }                                               \
352           _tmp;                                                \
353        } )
354
355static __inline__ int
356message_send(unsigned int size, unsigned int code,
357    unsigned int stid, struct msgrng_msg *msg)
358{
359	unsigned int dest = 0;
360	unsigned long long status = 0;
361	int i = 0;
362
363	msgrng_load_tx_msg0(msg->msg0);
364	msgrng_load_tx_msg1(msg->msg1);
365	msgrng_load_tx_msg2(msg->msg2);
366	msgrng_load_tx_msg3(msg->msg3);
367
368	dest = ((size - 1) << 16) | (code << 8) | (stid);
369
370	//dbg_msg("Sending msg<%Lx,%Lx,%Lx,%Lx> to dest = %x\n",
371	    //msg->msg0, msg->msg1, msg->msg2, msg->msg3, dest);
372
373	msgrng_send(dest);
374
375	for (i = 0; i < 16; i++) {
376		status = msgrng_read_status();
377		//dbg_msg("status = %Lx\n", status);
378
379		if (status & 0x6) {
380			continue;
381		} else
382			break;
383	}
384	if (i == 16) {
385		if (dest == 0x61)
386			//dbg_msg("Processor %x: Unable to send msg to %llx\n", processor_id(), dest);
387		return status & 0x6;
388	}
389	return msgrng_read_status() & 0x06;
390}
391
392static __inline__ int
393message_send_retry(unsigned int size, unsigned int code,
394    unsigned int stid, struct msgrng_msg *msg)
395{
396	int res = 0;
397	int retry = 0;
398
399	for (;;) {
400		res = message_send(size, code, stid, msg);
401		/* retry a pending fail */
402		if (res & 0x02)
403			continue;
404		/* credit fail */
405		if (res & 0x04)
406			retry++;
407		else
408			break;
409		if (retry == 4)
410			return res & 0x06;
411	}
412
413	return 0;
414}
415
416static __inline__ int
417message_receive(int pri, int *size, int *code, int *src_id,
418    struct msgrng_msg *msg)
419{
420	int res = message_receive_fast(pri, *size, *code, *src_id, msg->msg0, msg->msg1, msg->msg2, msg->msg3);
421
422#ifdef MSGRING_DUMP_MESSAGES
423	if (!res) {
424		dbg_msg("Received msg <%llx, %llx, %llx, %llx> <%d,%d,%d>\n",
425		    msg->msg0, msg->msg1, msg->msg2, msg->msg3,
426		    *size, *code, *src_id);
427	}
428#endif
429
430	return res;
431}
432
433#define MSGRNG_STN_RX_QSIZE 256
434
435struct stn_cc {
436	unsigned short counters[16][8];
437};
438
439struct bucket_size {
440	unsigned short bucket[128];
441};
442
443extern struct bucket_size bucket_sizes;
444
445extern struct stn_cc cc_table_cpu_0;
446extern struct stn_cc cc_table_cpu_1;
447extern struct stn_cc cc_table_cpu_2;
448extern struct stn_cc cc_table_cpu_3;
449extern struct stn_cc cc_table_cpu_4;
450extern struct stn_cc cc_table_cpu_5;
451extern struct stn_cc cc_table_cpu_6;
452extern struct stn_cc cc_table_cpu_7;
453extern struct stn_cc cc_table_xgs_0;
454extern struct stn_cc cc_table_xgs_1;
455extern struct stn_cc cc_table_gmac;
456extern struct stn_cc cc_table_dma;
457extern struct stn_cc cc_table_sec;
458
459extern struct bucket_size xls_bucket_sizes;
460
461extern struct stn_cc xls_cc_table_cpu_0;
462extern struct stn_cc xls_cc_table_cpu_1;
463extern struct stn_cc xls_cc_table_cpu_2;
464extern struct stn_cc xls_cc_table_cpu_3;
465extern struct stn_cc xls_cc_table_gmac0;
466extern struct stn_cc xls_cc_table_gmac1;
467extern struct stn_cc xls_cc_table_cmp;
468extern struct stn_cc xls_cc_table_pcie;
469extern struct stn_cc xls_cc_table_dma;
470extern struct stn_cc xls_cc_table_sec;
471
472
473#define msgrng_access_save(lock, mflags) do {                \
474  if (rmi_spin_mutex_safe) mtx_lock_spin(lock);              \
475  msgrng_flags_save(mflags);                                 \
476 }while(0)
477
478#define msgrng_access_restore(lock, mflags) do {             \
479  msgrng_flags_restore(mflags);                              \
480  if (rmi_spin_mutex_safe) mtx_unlock_spin(lock);            \
481 }while(0)
482
483#define msgrng_access_enable(mflags) do {   \
484  critical_enter();                         \
485  msgrng_flags_save(mflags);                \
486} while(0)
487
488#define msgrng_access_disable(mflags) do {   \
489  msgrng_flags_restore(mflags);              \
490  critical_exit();                           \
491} while(0)
492
493/*
494 * NOTE: this is not stationid/8, ie the station numbers below are just
495 * for internal use
496 */
497enum {
498	TX_STN_CPU_0,
499	TX_STN_CPU_1,
500	TX_STN_CPU_2,
501	TX_STN_CPU_3,
502	TX_STN_CPU_4,
503	TX_STN_CPU_5,
504	TX_STN_CPU_6,
505	TX_STN_CPU_7,
506	TX_STN_GMAC,
507	TX_STN_DMA,
508	TX_STN_XGS_0,
509	TX_STN_XGS_1,
510	TX_STN_SAE,
511	TX_STN_GMAC0,
512	TX_STN_GMAC1,
513	TX_STN_CDE,
514	TX_STN_PCIE,
515	TX_STN_INVALID,
516	MAX_TX_STNS
517};
518
519extern int
520register_msgring_handler(int major,
521    void (*action) (int, int, int, int, struct msgrng_msg *, void *),
522    void *dev_id);
523	extern void xlr_msgring_cpu_init(void);
524
525	extern void xlr_msgring_config(void);
526
527#define cpu_to_msgring_bucket(cpu) ((((cpu) >> 2)<<3)|((cpu) & 0x03))
528
529#endif
530