tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*
2 * Copyright (C) 2014 Texas Instruments Incorporated
3 * Authors: Sandeep Nair <sandeep_n@ti.com
4 * Cyril Chemparathy <cyril@ti.com
5 Santosh Shilimkar <santosh.shilimkar@ti.com>
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation version 2.
10 *
11 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
12 * kind, whether express or implied; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 */
16
17#ifndef __SOC_TI_KEYSTONE_NAVIGATOR_DMA_H__
18#define __SOC_TI_KEYSTONE_NAVIGATOR_DMA_H__
19
20/*
21 * PKTDMA descriptor manipulation macros for host packet descriptor
22 */
23#define MASK(x) (BIT(x) - 1)
24#define KNAV_DMA_DESC_PKT_LEN_MASK MASK(22)
25#define KNAV_DMA_DESC_PKT_LEN_SHIFT 0
26#define KNAV_DMA_DESC_PS_INFO_IN_SOP BIT(22)
27#define KNAV_DMA_DESC_PS_INFO_IN_DESC 0
28#define KNAV_DMA_DESC_TAG_MASK MASK(8)
29#define KNAV_DMA_DESC_SAG_HI_SHIFT 24
30#define KNAV_DMA_DESC_STAG_LO_SHIFT 16
31#define KNAV_DMA_DESC_DTAG_HI_SHIFT 8
32#define KNAV_DMA_DESC_DTAG_LO_SHIFT 0
33#define KNAV_DMA_DESC_HAS_EPIB BIT(31)
34#define KNAV_DMA_DESC_NO_EPIB 0
35#define KNAV_DMA_DESC_PSLEN_SHIFT 24
36#define KNAV_DMA_DESC_PSLEN_MASK MASK(6)
37#define KNAV_DMA_DESC_ERR_FLAG_SHIFT 20
38#define KNAV_DMA_DESC_ERR_FLAG_MASK MASK(4)
39#define KNAV_DMA_DESC_PSFLAG_SHIFT 16
40#define KNAV_DMA_DESC_PSFLAG_MASK MASK(4)
41#define KNAV_DMA_DESC_RETQ_SHIFT 0
42#define KNAV_DMA_DESC_RETQ_MASK MASK(14)
43#define KNAV_DMA_DESC_BUF_LEN_MASK MASK(22)
44
45#define KNAV_DMA_NUM_EPIB_WORDS 4
46#define KNAV_DMA_NUM_PS_WORDS 16
47#define KNAV_DMA_NUM_SW_DATA_WORDS 4
48#define KNAV_DMA_FDQ_PER_CHAN 4
49
50/* Tx channel scheduling priority */
51enum knav_dma_tx_priority {
52 DMA_PRIO_HIGH = 0,
53 DMA_PRIO_MED_H,
54 DMA_PRIO_MED_L,
55 DMA_PRIO_LOW
56};
57
58/* Rx channel error handling mode during buffer starvation */
59enum knav_dma_rx_err_mode {
60 DMA_DROP = 0,
61 DMA_RETRY
62};
63
64/* Rx flow size threshold configuration */
65enum knav_dma_rx_thresholds {
66 DMA_THRESH_NONE = 0,
67 DMA_THRESH_0 = 1,
68 DMA_THRESH_0_1 = 3,
69 DMA_THRESH_0_1_2 = 7
70};
71
72/* Descriptor type */
73enum knav_dma_desc_type {
74 DMA_DESC_HOST = 0,
75 DMA_DESC_MONOLITHIC = 2
76};
77
78/**
79 * struct knav_dma_tx_cfg: Tx channel configuration
80 * @filt_einfo: Filter extended packet info
81 * @filt_pswords: Filter PS words present
82 * @knav_dma_tx_priority: Tx channel scheduling priority
83 */
84struct knav_dma_tx_cfg {
85 bool filt_einfo;
86 bool filt_pswords;
87 enum knav_dma_tx_priority priority;
88};
89
90/**
91 * struct knav_dma_rx_cfg: Rx flow configuration
92 * @einfo_present: Extended packet info present
93 * @psinfo_present: PS words present
94 * @knav_dma_rx_err_mode: Error during buffer starvation
95 * @knav_dma_desc_type: Host or Monolithic desc
96 * @psinfo_at_sop: PS word located at start of packet
97 * @sop_offset: Start of packet offset
98 * @dst_q: Destination queue for a given flow
99 * @thresh: Rx flow size threshold
100 * @fdq[]: Free desc Queue array
101 * @sz_thresh0: RX packet size threshold 0
102 * @sz_thresh1: RX packet size threshold 1
103 * @sz_thresh2: RX packet size threshold 2
104 */
105struct knav_dma_rx_cfg {
106 bool einfo_present;
107 bool psinfo_present;
108 enum knav_dma_rx_err_mode err_mode;
109 enum knav_dma_desc_type desc_type;
110 bool psinfo_at_sop;
111 unsigned int sop_offset;
112 unsigned int dst_q;
113 enum knav_dma_rx_thresholds thresh;
114 unsigned int fdq[KNAV_DMA_FDQ_PER_CHAN];
115 unsigned int sz_thresh0;
116 unsigned int sz_thresh1;
117 unsigned int sz_thresh2;
118};
119
120/**
121 * struct knav_dma_cfg: Pktdma channel configuration
122 * @sl_cfg: Slave configuration
123 * @tx: Tx channel configuration
124 * @rx: Rx flow configuration
125 */
126struct knav_dma_cfg {
127 enum dma_transfer_direction direction;
128 union {
129 struct knav_dma_tx_cfg tx;
130 struct knav_dma_rx_cfg rx;
131 } u;
132};
133
134/**
135 * struct knav_dma_desc: Host packet descriptor layout
136 * @desc_info: Descriptor information like id, type, length
137 * @tag_info: Flow tag info written in during RX
138 * @packet_info: Queue Manager, policy, flags etc
139 * @buff_len: Buffer length in bytes
140 * @buff: Buffer pointer
141 * @next_desc: For chaining the descriptors
142 * @orig_len: length since 'buff_len' can be overwritten
143 * @orig_buff: buff pointer since 'buff' can be overwritten
144 * @epib: Extended packet info block
145 * @psdata: Protocol specific
146 * @sw_data: Software private data not touched by h/w
147 */
148struct knav_dma_desc {
149 __le32 desc_info;
150 __le32 tag_info;
151 __le32 packet_info;
152 __le32 buff_len;
153 __le32 buff;
154 __le32 next_desc;
155 __le32 orig_len;
156 __le32 orig_buff;
157 __le32 epib[KNAV_DMA_NUM_EPIB_WORDS];
158 __le32 psdata[KNAV_DMA_NUM_PS_WORDS];
159 u32 sw_data[KNAV_DMA_NUM_SW_DATA_WORDS];
160} ____cacheline_aligned;
161
162#if IS_ENABLED(CONFIG_KEYSTONE_NAVIGATOR_DMA)
163void *knav_dma_open_channel(struct device *dev, const char *name,
164 struct knav_dma_cfg *config);
165void knav_dma_close_channel(void *channel);
166#else
167static inline void *knav_dma_open_channel(struct device *dev, const char *name,
168 struct knav_dma_cfg *config)
169{
170 return (void *) NULL;
171}
172static inline void knav_dma_close_channel(void *channel)
173{}
174
175#endif
176
177#endif /* __SOC_TI_KEYSTONE_NAVIGATOR_DMA_H__ */