1*5113495bSYour Name /*
2*5113495bSYour Name * Copyright (c) 2018, 2020 The Linux Foundation. All rights reserved.
3*5113495bSYour Name * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name *
5*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name * above copyright notice and this permission notice appear in all
8*5113495bSYour Name * copies.
9*5113495bSYour Name *
10*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name */
19*5113495bSYour Name
20*5113495bSYour Name /**
21*5113495bSYour Name * DOC: qdf_streamfs.h
22*5113495bSYour Name * This file provides OS abstraction for stream filesystem APIs.
23*5113495bSYour Name */
24*5113495bSYour Name
25*5113495bSYour Name #ifndef _QDF_STREAMFS_H
26*5113495bSYour Name #define _QDF_STREAMFS_H
27*5113495bSYour Name
28*5113495bSYour Name #include <i_qdf_streamfs.h>
29*5113495bSYour Name #include <qdf_types.h>
30*5113495bSYour Name #include <qdf_debugfs.h>
31*5113495bSYour Name
32*5113495bSYour Name typedef __qdf_streamfs_chan_t qdf_streamfs_chan_t;
33*5113495bSYour Name typedef __qdf_streamfs_chan_buf_t qdf_streamfs_chan_buf_t;
34*5113495bSYour Name
35*5113495bSYour Name #ifdef WLAN_STREAMFS
36*5113495bSYour Name /**
37*5113495bSYour Name * qdf_streamfs_create_dir() - wrapper to create a debugfs directory
38*5113495bSYour Name * @name: name of the new directory
39*5113495bSYour Name * @parent: parent node. If NULL, defaults to base qdf_debugfs_root
40*5113495bSYour Name *
41*5113495bSYour Name * Return: dentry structure pointer in case of success, otherwise NULL.
42*5113495bSYour Name *
43*5113495bSYour Name */
qdf_streamfs_create_dir(const char * name,qdf_dentry_t parent)44*5113495bSYour Name static inline qdf_dentry_t qdf_streamfs_create_dir(
45*5113495bSYour Name const char *name, qdf_dentry_t parent)
46*5113495bSYour Name {
47*5113495bSYour Name return qdf_debugfs_create_dir(name, parent);
48*5113495bSYour Name }
49*5113495bSYour Name
50*5113495bSYour Name /**
51*5113495bSYour Name * qdf_streamfs_remove_file() - wrapper to remove streamfs file
52*5113495bSYour Name * @d: streamfs node
53*5113495bSYour Name *
54*5113495bSYour Name */
qdf_streamfs_remove_file(qdf_dentry_t d)55*5113495bSYour Name static inline void qdf_streamfs_remove_file(qdf_dentry_t d)
56*5113495bSYour Name {
57*5113495bSYour Name qdf_debugfs_remove_file(d);
58*5113495bSYour Name }
59*5113495bSYour Name
60*5113495bSYour Name /**
61*5113495bSYour Name * qdf_streamfs_remove_dir_recursive() - wrapper to remove directory recursively
62*5113495bSYour Name * @d: debugfs node
63*5113495bSYour Name *
64*5113495bSYour Name * This function will recursively remove a directory in streamfs that was
65*5113495bSYour Name * previously created with a call to qdf_debugfs_create_file() or it's
66*5113495bSYour Name * variant functions.
67*5113495bSYour Name */
qdf_streamfs_remove_dir_recursive(qdf_dentry_t d)68*5113495bSYour Name static inline void qdf_streamfs_remove_dir_recursive(qdf_dentry_t d)
69*5113495bSYour Name {
70*5113495bSYour Name qdf_debugfs_remove_dir_recursive(d);
71*5113495bSYour Name }
72*5113495bSYour Name
73*5113495bSYour Name /**
74*5113495bSYour Name * qdf_streamfs_create_file() - Create streamfs chan buffer file
75*5113495bSYour Name * @name: base name of file to create
76*5113495bSYour Name * @mode: filemode
77*5113495bSYour Name * @parent: dentry of parent directory, NULL for root directory
78*5113495bSYour Name * @buf: pointer to chan buffer
79*5113495bSYour Name *
80*5113495bSYour Name * Returns file dentry pointer if successful, NULL otherwise.
81*5113495bSYour Name */
82*5113495bSYour Name qdf_dentry_t qdf_streamfs_create_file(const char *name, uint16_t mode,
83*5113495bSYour Name qdf_dentry_t parent,
84*5113495bSYour Name qdf_streamfs_chan_buf_t buf);
85*5113495bSYour Name
86*5113495bSYour Name /**
87*5113495bSYour Name * qdf_streamfs_open() - Create streamfs channel for data transfer
88*5113495bSYour Name * @base_filename: base name of files to create, %NULL for buffering only
89*5113495bSYour Name * @parent: dentry of parent directory, %NULL for root directory
90*5113495bSYour Name * @subbuf_size: size of sub-buffers
91*5113495bSYour Name * @n_subbufs: number of sub-buffers
92*5113495bSYour Name * @private_data: user-defined data
93*5113495bSYour Name *
94*5113495bSYour Name * Returns channel pointer if successful, %NULL otherwise.
95*5113495bSYour Name */
96*5113495bSYour Name qdf_streamfs_chan_t qdf_streamfs_open(const char *base_filename,
97*5113495bSYour Name qdf_dentry_t parent,
98*5113495bSYour Name size_t subbuf_size, size_t n_subbufs,
99*5113495bSYour Name void *private_data);
100*5113495bSYour Name
101*5113495bSYour Name /**
102*5113495bSYour Name * qdf_streamfs_close() - Closes all channel buffers and frees the channel.
103*5113495bSYour Name * @chan: pointer to qdf_streamfs_chan.
104*5113495bSYour Name *
105*5113495bSYour Name * Returns NONE
106*5113495bSYour Name */
107*5113495bSYour Name void qdf_streamfs_close(qdf_streamfs_chan_t chan);
108*5113495bSYour Name
109*5113495bSYour Name /**
110*5113495bSYour Name * qdf_streamfs_flush() - Flushes all channel buffers.
111*5113495bSYour Name * @chan: pointer to qdf_streamfs_chan.
112*5113495bSYour Name *
113*5113495bSYour Name * Returns NONE
114*5113495bSYour Name */
115*5113495bSYour Name void qdf_streamfs_flush(qdf_streamfs_chan_t chan);
116*5113495bSYour Name
117*5113495bSYour Name /**
118*5113495bSYour Name * qdf_streamfs_reset() - Reset streamfs channel
119*5113495bSYour Name * @chan: pointer to qdf_streamfs_chan.
120*5113495bSYour Name *
121*5113495bSYour Name * This erases data from all channel buffers and restarting the channel
122*5113495bSYour Name * in its initial state. The buffers are not freed, so any mappings are
123*5113495bSYour Name * still in effect.
124*5113495bSYour Name *
125*5113495bSYour Name * Returns NONE
126*5113495bSYour Name */
127*5113495bSYour Name void qdf_streamfs_reset(qdf_streamfs_chan_t chan);
128*5113495bSYour Name
129*5113495bSYour Name /**
130*5113495bSYour Name * qdf_streamfs_subbufs_consumed() - update the buffer's sub-buffers-consumed
131*5113495bSYour Name * count
132*5113495bSYour Name * @chan: pointer to qdf_streamfs_chan.
133*5113495bSYour Name * @cpu: the cpu associated with the channel buffer to update
134*5113495bSYour Name * @consumed: number of sub-buffers to add to current buf's count
135*5113495bSYour Name *
136*5113495bSYour Name * Returns NONE
137*5113495bSYour Name */
138*5113495bSYour Name void qdf_streamfs_subbufs_consumed(qdf_streamfs_chan_t chan,
139*5113495bSYour Name unsigned int cpu,
140*5113495bSYour Name size_t consumed);
141*5113495bSYour Name
142*5113495bSYour Name /**
143*5113495bSYour Name * qdf_streamfs_write() - write data into the channel
144*5113495bSYour Name * @chan: relay channel
145*5113495bSYour Name * @data: data to be written
146*5113495bSYour Name * @length: number of bytes to write
147*5113495bSYour Name *
148*5113495bSYour Name * Writes data into the current cpu's channel buffer.
149*5113495bSYour Name */
150*5113495bSYour Name void qdf_streamfs_write(qdf_streamfs_chan_t chan, const void *data,
151*5113495bSYour Name size_t length);
152*5113495bSYour Name #else
qdf_streamfs_create_dir(const char * name,qdf_dentry_t parent)153*5113495bSYour Name static inline qdf_dentry_t qdf_streamfs_create_dir(
154*5113495bSYour Name const char *name, qdf_dentry_t parent)
155*5113495bSYour Name {
156*5113495bSYour Name return NULL;
157*5113495bSYour Name }
158*5113495bSYour Name
qdf_streamfs_remove_file(qdf_dentry_t d)159*5113495bSYour Name static inline void qdf_streamfs_remove_file(qdf_dentry_t d)
160*5113495bSYour Name {
161*5113495bSYour Name }
162*5113495bSYour Name
qdf_streamfs_remove_dir_recursive(qdf_dentry_t d)163*5113495bSYour Name static inline void qdf_streamfs_remove_dir_recursive(qdf_dentry_t d)
164*5113495bSYour Name {
165*5113495bSYour Name }
166*5113495bSYour Name
167*5113495bSYour Name static inline
qdf_streamfs_create_file(const char * name,uint16_t mode,qdf_dentry_t parent,qdf_streamfs_chan_buf_t buf)168*5113495bSYour Name qdf_dentry_t qdf_streamfs_create_file(const char *name, uint16_t mode,
169*5113495bSYour Name qdf_dentry_t parent,
170*5113495bSYour Name qdf_streamfs_chan_buf_t buf)
171*5113495bSYour Name {
172*5113495bSYour Name return NULL;
173*5113495bSYour Name }
174*5113495bSYour Name
175*5113495bSYour Name static inline
qdf_streamfs_open(const char * base_filename,qdf_dentry_t parent,size_t subbuf_size,size_t n_subbufs,void * private_data)176*5113495bSYour Name qdf_streamfs_chan_t qdf_streamfs_open(const char *base_filename,
177*5113495bSYour Name qdf_dentry_t parent,
178*5113495bSYour Name size_t subbuf_size, size_t n_subbufs,
179*5113495bSYour Name void *private_data)
180*5113495bSYour Name {
181*5113495bSYour Name return NULL;
182*5113495bSYour Name }
183*5113495bSYour Name
qdf_streamfs_close(qdf_streamfs_chan_t chan)184*5113495bSYour Name static inline void qdf_streamfs_close(qdf_streamfs_chan_t chan)
185*5113495bSYour Name {
186*5113495bSYour Name }
187*5113495bSYour Name
qdf_streamfs_flush(qdf_streamfs_chan_t chan)188*5113495bSYour Name static inline void qdf_streamfs_flush(qdf_streamfs_chan_t chan)
189*5113495bSYour Name {
190*5113495bSYour Name }
191*5113495bSYour Name
qdf_streamfs_reset(qdf_streamfs_chan_t chan)192*5113495bSYour Name static inline void qdf_streamfs_reset(qdf_streamfs_chan_t chan)
193*5113495bSYour Name {
194*5113495bSYour Name }
195*5113495bSYour Name
196*5113495bSYour Name static inline void
qdf_streamfs_subbufs_consumed(qdf_streamfs_chan_t chan,unsigned int cpu,size_t consumed)197*5113495bSYour Name qdf_streamfs_subbufs_consumed(qdf_streamfs_chan_t chan,
198*5113495bSYour Name unsigned int cpu, size_t consumed)
199*5113495bSYour Name {
200*5113495bSYour Name }
201*5113495bSYour Name
202*5113495bSYour Name static inline void
qdf_streamfs_write(qdf_streamfs_chan_t chan,const void * data,size_t length)203*5113495bSYour Name qdf_streamfs_write(qdf_streamfs_chan_t chan, const void *data,
204*5113495bSYour Name size_t length)
205*5113495bSYour Name {
206*5113495bSYour Name }
207*5113495bSYour Name #endif /* WLAN_STREAMFS */
208*5113495bSYour Name #endif /* _QDF_STREAMFS_H */
209