xref: /openbsd/sys/arch/octeon/dev/cn30xxfauvar.h (revision a8b58197)
1 /*	$OpenBSD: cn30xxfauvar.h,v 1.5 2024/05/20 23:13:33 jsg Exp $	*/
2 
3 /*
4  * Copyright (c) 2007 Internet Initiative Japan, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _CN30XXFAUVAR_H_
30 #define _CN30XXFAUVAR_H_
31 
32 /* ---- API */
33 
34 struct cn30xxfau_desc {
35 	/* offset in scratch buffer */
36 	size_t		fd_scroff;	/* XXX offset_t */
37 	/* FAU register number */
38 	size_t		fd_regno;	/* XXX offset_t */
39 };
40 
41 void		cn30xxfau_op_init(struct cn30xxfau_desc *, size_t, size_t);
42 uint64_t	cn30xxfau_op_save(struct cn30xxfau_desc *);
43 void		cn30xxfau_op_restore(struct cn30xxfau_desc *, uint64_t);
44 int64_t		cn30xxfau_op_inc_8(struct cn30xxfau_desc *, int64_t);
45 int64_t		cn30xxfau_op_incwait_8(struct cn30xxfau_desc *, int);
46 void		cn30xxfau_op_add_8(struct cn30xxfau_desc *, int64_t);
47 void		cn30xxfau_op_set_8(struct cn30xxfau_desc *, int64_t);
48 
49 /* ---- old API */
50 
51 /* XXX */
52 #define OCT_FAU_REG_OQ_ADDR_INDEX (0)
53 #define OCT_FAU_REG_ADDR_END (256)
54 /* XXX */
55 
56 /* XXX */
57 typedef enum {
58 	OCT_FAU_OP_SIZE_8  = 0,
59 	OCT_FAU_OP_SIZE_16 = 1,
60 	OCT_FAU_OP_SIZE_32 = 2,
61 	OCT_FAU_OP_SIZE_64 = 3
62 } fau_op_size_t;
63 /* XXX */
64 
65 static inline void
cn30xxfau_op_iobdma(int index,uint64_t args)66 cn30xxfau_op_iobdma(int index, uint64_t args)
67 {
68 	uint64_t value;
69 
70 	value =
71 	    ((uint64_t)(index & 0xff) << 56) |
72 	    ((uint64_t)1 << 48) |
73 	    ((uint64_t)(CN30XXFAU_MAJORDID & 0x1f) << 43) |
74 	    ((uint64_t)(CN30XXFAU_SUBDID & 0x7) << 40) |
75 	    ((uint64_t)args & 0xfffffffffULL);
76 	octeon_iobdma_write_8(value);
77 }
78 
79 /* 3.4.2 IOBDMA Operations */
80 
81 /* IOBDMA Store Data for FAU Operations */
82 
83 static inline void
cn30xxfau_op_iobdma_store_data(int scraddr,int incval,int tagwait,int size,int reg)84 cn30xxfau_op_iobdma_store_data(int scraddr, int incval, int tagwait,
85     int size, int reg)
86 {
87 	uint64_t args;
88 
89 	args =
90 	    ((uint64_t)(incval & 0x3fffff) << 14) |
91 	    ((uint64_t)(tagwait & 0x1) << 13) |
92 	    ((uint64_t)(size & 0x3) << 11) |
93 	    ((uint64_t)(reg & 0x7ff) << 0);
94 	/* use `srcaddr` as `index' */
95 	cn30xxfau_op_iobdma((int)((uint32_t)scraddr >> 3) /* XXX */, args);
96 }
97 
98 static inline void
cn30xxfau_op_inc_fetch_8(struct cn30xxfau_desc * fd,int64_t v)99 cn30xxfau_op_inc_fetch_8(struct cn30xxfau_desc *fd, int64_t v)
100 {
101 	cn30xxfau_op_iobdma_store_data(fd->fd_scroff, v, 0, OCT_FAU_OP_SIZE_64/* XXX */,
102 	    fd->fd_regno);
103 }
104 
105 static inline int64_t
cn30xxfau_op_inc_read_8(struct cn30xxfau_desc * fd)106 cn30xxfau_op_inc_read_8(struct cn30xxfau_desc *fd)
107 {
108 	octeon_synciobdma();
109 	return octeon_cvmseg_read_8(fd->fd_scroff);
110 }
111 
112 #endif /* _CN30XXFAUVAR_H_ */
113