1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|
/*
* Copyright (C) 2010 Samsung Electronics.
*
* This software is licensed under the terms of the GNU General Public
* License version 2, as published by the Free Software Foundation, and
* may be copied, distributed, and modified under those terms.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
*/
#ifndef __MODEM_INCLUDE_SBD_H__
#define __MODEM_INCLUDE_SBD_H__
/**
@file sbd.h
@brief header file for shared buffer descriptor (SBD) architecture
designed by MIPI Alliance
@date 2014/02/05
@author Hankook Jang (hankook.jang@samsung.com)
*/
#ifdef GROUP_MEM_LINK_SBD
/**
@addtogroup group_mem_link_sbd
@{
*/
#include <linux/types.h>
#include <linux/platform_data/modem_v1.h>
#include "link_device_memory_config.h"
#include "circ_queue.h"
/*
Abbreviations
=============
SB, sb Shared Buffer
SBD, sbd Shared Buffer Descriptor
SBDV, sbdv Shared Buffer Descriptor Vector (Array)
--------
RB, rb Ring Buffer
RBO, rbo Ring Buffer Offset (offset of an RB)
RBD, rbd Ring Buffer Descriptor (descriptor of an RB)
RBDO, rbdo Ring Buffer Descriptor Offset (offset of an RBD)
--------
RBP, rbp Ring Buffer Pointer (read pointer, write pointer)
RBPS, rbps Ring Buffer Pointer Set (set of RBPs)
--------
CH, ch Channel
CHD, chd Channel Descriptor
--------
desc descriptor
*/
#define CMD_DESC_RGN_OFFSET 0
#define CMD_DESC_RGN_SIZE SZ_64K
#define CTRL_RGN_OFFSET (CMD_DESC_RGN_OFFSET)
#define CTRL_RGN_SIZE (1 * SZ_1K)
#define CMD_RGN_OFFSET (CTRL_RGN_OFFSET + CTRL_RGN_SIZE)
#define CMD_RGN_SIZE (1 * SZ_1K)
#define DESC_RGN_OFFSET (CMD_RGN_OFFSET + CMD_RGN_SIZE)
#define DESC_RGN_SIZE (CMD_DESC_RGN_SIZE - CTRL_RGN_SIZE - CMD_RGN_SIZE)
#define BUFF_RGN_OFFSET (CMD_DESC_RGN_SIZE)
/**
@brief SBD Ring Buffer Descriptor
(i.e. IPC Channel Descriptor Structure in MIPI LLI_IPC_AN)
*/
struct __packed sbd_rb_desc {
/*
ch Channel number defined in the Samsung IPC specification
--------
reserved
*/
u16 ch;
u16 reserved;
/*
direction 0 (UL, TX, AP-to-CP), 1 (DL, RX, CP-to-AP)
--------
signaling 0 (polling), 1 (interrupt)
*/
u16 direction;
u16 signaling;
/*
Mask to be written to the signal register (viz. 1 << @@id)
(i.e. write_signal)
*/
u32 sig_mask;
/*
length Length of an SBD Ring Buffer
--------
id (1) ID for a link channel that consists of an RB pair
(2) Index into each array in the set of RBP arrays
N.B. set of RBP arrays =
{[ul_rp], [ul_wp], [dl_rp], [dl_wp]}
*/
u16 length;
u16 id;
/*
buff_size Size of each data buffer in an SBD RB (default 2048)
--------
payload_offset Offset of the payload in each data buffer (default 0)
*/
u16 buff_size;
u16 payload_offset;
};
/**
@brief SBD Channel Descriptor
*/
struct __packed sbd_rb_channel {
u32 ul_rbd_offset; /* UL RB Descriptor Offset */
u32 ul_sbdv_offset; /* UL SBD Vectors's Offset */
u32 dl_rbd_offset; /* DL RB Descriptor's Offset */
u32 dl_sbdv_offset; /* DL SBD Vector's Offset */
};
/**
@brief SBD Global Descriptor
*/
struct __packed sbd_global_desc {
/*
Version
*/
u32 version;
/*
Number of link channels
*/
u32 num_channels;
/*
Offset of the array of "SBD Ring Buffer Pointers Set" in SHMEM
*/
u32 rbps_offset;
/*
Array of SBD channel descriptors
*/
struct sbd_rb_channel rb_ch[MAX_LINK_CHANNELS];
/*
Array of SBD ring buffer descriptor pairs
*/
struct sbd_rb_desc rb_desc[MAX_LINK_CHANNELS][ULDL];
};
#if 1
#endif
/**
@brief SBD ring buffer (with logical view)
@remark physical SBD ring buffer
= {length, *rp, *wp, offset array, size array}
*/
struct sbd_ring_buffer {
/*
Spin-lock for each SBD RB
*/
spinlock_t lock;
/*
Pointer to the "SBD link" device instance to which an RB belongs
*/
struct sbd_link_device *sl;
/*
UL/DL socket buffer queues
*/
struct sk_buff_head skb_q;
/*
Whether or not link-layer header is used
*/
bool lnk_hdr;
/*
Variables for receiving a frame with the SIPC5 "EXT_LEN" attribute
(With SBD architecture, a frame with EXT_LEN can be scattered into
consecutive multiple data buffer slots.)
*/
bool more;
unsigned int total;
unsigned int rcvd;
/*
Link ID, SIPC channel, and IPC direction
*/
u16 id; /* for @desc->id */
u16 ch; /* for @desc->ch */
u16 dir; /* for @desc->direction */
u16 len; /* for @desc->length */
u16 buff_size; /* for @desc->buff_size */
u16 payload_offset; /* for @desc->payload_offset */
/*
Pointer to the array of pointers to each data buffer
*/
u8 **buff;
/*
Pointer to the data buffer region in SHMEM
*/
u8 *buff_rgn;
/*
Pointers to variables in the shared region for a physical SBD RB
*/
u16 *rp; /* sl->rp[@dir][@id] */
u16 *wp; /* sl->wp[@dir][@id] */
u32 *addr_v; /* Vector array of offsets */
u32 *size_v; /* Vector array of sizes */
/*
Pointer to the IO device and the link device to which an SBD RB belongs
*/
struct io_device *iod;
struct link_device *ld;
};
struct sbd_link_attr {
/*
Link ID and SIPC channel number
*/
u16 id;
u16 ch;
/*
Whether or not link-layer header is used
*/
bool lnk_hdr;
/*
Length of an SBD RB
*/
unsigned int rb_len[ULDL];
/*
Size of the data buffer for each SBD in an SBD RB
*/
unsigned int buff_size[ULDL];
};
struct sbd_ipc_device {
/*
Pointer to the IO device to which an SBD IPC device belongs
*/
struct io_device *iod;
/*
SBD IPC device ID == Link ID --> rb.id
*/
u16 id;
/*
SIPC Channel ID --> rb.ch
*/
u16 ch;
atomic_t config_done;
/*
UL/DL SBD RB pair in the kernel space
*/
struct sbd_ring_buffer rb[ULDL];
};
struct sbd_link_device {
/*
Pointer to the link device to which an SBD link belongs
*/
struct link_device *ld;
/*
Flag for checking whether or not an SBD link is active
*/
atomic_t active;
/*
Version of SBD IPC
*/
unsigned int version;
/*
Start address of SHMEM
@shmem = SHMEM.VA
*/
u8 *shmem;
unsigned int shmem_size;
/*
Variables for DESC & BUFF allocation management
*/
unsigned int desc_alloc_offset;
unsigned int buff_alloc_offset;
/*
The number of link channels for AP-CP IPC
*/
unsigned int num_channels;
/*
Table of link attributes
*/
struct sbd_link_attr link_attr[MAX_LINK_CHANNELS];
/*
Logical IPC devices
*/
struct sbd_ipc_device ipc_dev[MAX_LINK_CHANNELS];
/*
(1) Conversion tables from "Link ID (ID)" to "SIPC Channel Number (CH)"
(2) Conversion tables from "SIPC Channel Number (CH)" to "Link ID (ID)"
*/
u16 id2ch[MAX_LINK_CHANNELS];
u16 ch2id[MAX_SIPC_CHANNELS];
/*
Pointers to each array of arrays of SBD RB Pointers,
viz. rp[UL] = pointer to ul_rp[]
rp[DL] = pointer to dl_rp[]
wp[UL] = pointer to ul_wp[]
wp[DL] = pointer to dl_wp[]
*/
u16 *rp[ULDL];
u16 *wp[ULDL];
/*
Above are variables for managing and controlling SBD IPC
========================================================================
Below are pointers to the descriptor sections in SHMEM
*/
/*
Pointer to the SBD global descriptor header
*/
struct sbd_global_desc *g_desc;
u16 *rbps;
unsigned long rxdone_mask;
struct pktlog_data *pktlog;
};
static inline void sbd_activate(struct sbd_link_device *sl)
{
if (sl)
atomic_set(&sl->active, 1);
}
static inline void sbd_deactivate(struct sbd_link_device *sl)
{
if (sl)
atomic_set(&sl->active, 0);
}
static inline bool sbd_active(struct sbd_link_device *sl)
{
if (!sl)
return false;
return atomic_read(&sl->active) ? true : false;
}
static inline u16 sbd_ch2id(struct sbd_link_device *sl, u16 ch)
{
return sl->ch2id[ch];
}
static inline u16 sbd_id2ch(struct sbd_link_device *sl, u16 id)
{
return sl->id2ch[id];
}
static inline struct sbd_ipc_device *sbd_ch2dev(struct sbd_link_device *sl,
u16 ch)
{
u16 id = sbd_ch2id(sl, ch);
return (id < MAX_LINK_CHANNELS) ? &sl->ipc_dev[id] : NULL;
}
static inline struct sbd_ipc_device *sbd_id2dev(struct sbd_link_device *sl,
u16 id)
{
return (id < MAX_LINK_CHANNELS) ? &sl->ipc_dev[id] : NULL;
}
static inline struct sbd_ring_buffer *sbd_ch2rb(struct sbd_link_device *sl,
unsigned int ch,
enum direction dir)
{
u16 id = sbd_ch2id(sl, ch);
return (id < MAX_LINK_CHANNELS) ? &sl->ipc_dev[id].rb[dir] : NULL;
}
static inline struct sbd_ring_buffer *sbd_id2rb(struct sbd_link_device *sl,
unsigned int id,
enum direction dir)
{
return (id < MAX_LINK_CHANNELS) ? &sl->ipc_dev[id].rb[dir] : NULL;
}
static inline bool rb_empty(struct sbd_ring_buffer *rb)
{
return circ_empty(*rb->rp, *rb->wp);
}
static inline unsigned int rb_space(struct sbd_ring_buffer *rb)
{
return circ_get_space(rb->len, *rb->wp, *rb->rp);
}
static inline unsigned int rb_usage(struct sbd_ring_buffer *rb)
{
return circ_get_usage(rb->len, *rb->wp, *rb->rp);
}
static inline unsigned int rb_full(struct sbd_ring_buffer *rb)
{
return (rb_space(rb) == 0);
}
int create_sbd_link_device(struct link_device *ld, struct sbd_link_device *sl,
u8 *shmem_base, unsigned int shmem_size);
int init_sbd_link(struct sbd_link_device *sl);
int sbd_pio_tx(struct sbd_ring_buffer *rb, struct sk_buff *skb);
struct sk_buff *sbd_pio_rx(struct sbd_ring_buffer *rb);
int tx_frames_to_rb(struct sbd_ring_buffer *rb);
#define SBD_UL_LIMIT 16 /* Uplink burst limit */
/**
// End of group_mem_link_sbd
@}
*/
#endif
#endif
|