WXK
2025-02-11 e328ebef585cea2351b37117b2d5ac4978ecd3c0
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
/*
 * Copyright (c) 2019-2023 Beijing Hanwei Innovation Technology Ltd. Co. and
 * its subsidiaries and affiliates (collectly called MKSEMI).
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into an MKSEMI
 *    integrated circuit in a product or a software update for such product,
 *    must reproduce the above copyright notice, this list of conditions and
 *    the following disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * 3. Neither the name of MKSEMI nor the names of its contributors may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 *    MKSEMI integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be
 *    reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY MKSEMI "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL MKSEMI OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef MK_LSP_H_
#define MK_LSP_H_
#include "mk_common.h"
 
#ifndef LSP_INT_MODE_EN
#define LSP_INT_MODE_EN (1)
#endif
 
/**
 * @addtogroup MK8000_LSP
 * @{
 */
 
/**
 * @brief Instance structure for the floating-point matrix structure.
 */
struct LSP_MATRIX_T
{
    uint16_t num_rows; /**< number of rows of the matrix.     */
    uint16_t num_cols; /**< number of columns of the matrix.  */
    float *data;       /**< points to the data of the matrix. */
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**
 * @brief open LSP.
 *
 * @param int_en interrupt enable flag
 * @param callback register a callback
 */
int lsp_open(uint8_t int_en, drv_callback_t callback);
 
/**
 * @brief close LSP.
 */
int lsp_close(void);
 
/**
 * @brief Floating-point vector addition.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_add_f32(const float *pSrcA, const float *pSrcB, float *pDst, uint32_t blkCnt);
 
/**
 * @brief 8bit integer vector addition.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_add_int8(const int8_t *pSrcA, const int8_t *pSrcB, int16_t *pDst, uint32_t blkCnt);
 
/**
 * @brief 16bit integer vector addition.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_add_int16(const int16_t *pSrcA, const int16_t *pSrcB, int32_t *pDst, uint32_t blkCnt);
 
/**
 * @brief 32bit integer vector addition.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_add_int32(const int32_t *pSrcA, const int32_t *pSrcB, int32_t *pDst, uint32_t blkCnt);
 
/**
 * @brief Floating-point vector subtraction.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_sub_f32(const float *pSrcA, const float *pSrcB, float *pDst, uint32_t blkCnt);
 
/**
 * @brief 8bit integer vector subtraction.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_sub_int8(const int8_t *pSrcA, const int8_t *pSrcB, int16_t *pDst, uint32_t blkCnt);
 
/**
 * @brief 16bit integer vector subtraction.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_sub_int16(const int16_t *pSrcA, const int16_t *pSrcB, int32_t *pDst, uint32_t blkCnt);
 
/**
 * @brief 32bit integer vector subtraction.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_sub_int32(const int32_t *pSrcA, const int32_t *pSrcB, int32_t *pDst, uint32_t blkCnt);
 
/**
 * @brief Floating-point vector multiplication.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_mult_f32(const float *pSrcA, const float *pSrcB, float *pDst, uint32_t blkCnt);
 
/**
 * @brief 8bit integer vector multiplication.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_mult_int8(const int8_t *pSrcA, const int8_t *pSrcB, int16_t *pDst, uint32_t blkCnt);
 
/**
 * @brief 16bit integer vector multiplication.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_mult_int16(const int16_t *pSrcA, const int16_t *pSrcB, int32_t *pDst, uint32_t blkCnt);
 
/**
 * @brief 32bit integer vector multiplication.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_mult_int32(const int32_t *pSrcA, const int32_t *pSrcB, int32_t *pDst, uint32_t blkCnt);
 
/**
 * @brief Floating-point vector inverse.
 * @param[in]  pSrc       points to the instance of the input vector.
 * @param[out] pDst       points to the instance of the output vector.
 * @param[in]  blkCnt     number of samples in intput vector
 */
void lsp_vinverse_f32(const float *pSrc, float *pDst, uint32_t blkCnt);
 
/**
 * @brief 8bit integer vector inverse.
 * @param[in]  pSrc       points to the instance of the input vector.
 * @param[out] pDst       points to the instance of the output vector.
 * @param[in]  blkCnt     number of samples in intput vector
 */
void lsp_vinverse_int8(const int8_t *pSrc, float *pDst, uint32_t blkCnt);
 
/**
 * @brief 16bit integer vector inverse.
 * @param[in]  pSrc       points to the instance of the input vector.
 * @param[out] pDst       points to the instance of the output vector.
 * @param[in]  blkCnt     number of samples in intput vector
 */
void lsp_vinverse_int16(const int16_t *pSrc, float *pDst, uint32_t blkCnt);
 
/**
 * @brief 32bit integer vector inverse.
 * @param[in]  pSrc       points to the instance of the input vector.
 * @param[out] pDst       points to the instance of the output vector.
 * @param[in]  blkCnt     number of samples in intput vector
 */
void lsp_vinverse_int32(const int32_t *pSrc, float *pDst, uint32_t blkCnt);
 
/**
 * @brief Floating-point vector inner product.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_inner_product_f32(const float *pSrcA, const float *pSrcB, float *pDst, uint32_t blkCnt);
 
/**
 * @brief 8bit integer vector inner product.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_inner_product_int8(const int8_t *pSrcA, const int8_t *pSrcB, int32_t *pDst, uint32_t blkCnt);
 
/**
 * @brief 16bit integer vector inner product.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_inner_product_int16(const int16_t *pSrcA, const int16_t *pSrcB, float *pDst, uint32_t blkCnt);
 
/**
 * @brief 32bit integer vector inner product.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  pSrcB      points to the second input vector
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in each vector
 */
void lsp_inner_product_int32(const int32_t *pSrcA, const int32_t *pSrcB, float *pDst, uint32_t blkCnt);
 
/**
 * @brief Floating-point vector inner product searching to find out the maximum or minimum result.
 * @param[in]  pSrcA      points to the first input vector
 * @param[in]  srcALen    the length of input vector SrcA, srcALen <= 16
 * @param[in]  pSrcB      points to the second input vector
 * @param[in]  iterations iteration times
 * @param[out] pDst       points to the output vector
 * @param[in]  isMax      maximum or minimum
 * @return the maximum or minimum inner product iteration count
 */
uint32_t lsp_correlate_f32(const float *pSrcA, uint32_t srcALen, const int8_t *pSrcB, uint32_t iterations, float *pDst, uint8_t isMax);
 
/**
 * @brief Multiplies a floating-point vector by a scalar.
 * @param[in]  pSrc       points to the input vector
 * @param[in]  scale      scale factor to be applied
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of samples in the vector
 */
void lsp_scale_f32(const float *pSrc, float scale, float *pDst, uint32_t blkCnt);
 
/**
 * @brief  integer 8 complex-by-complex multiplication
 * @param[in]  pSrcA       points to the first input vector
 * @param[in]  pSrcB       points to the second input vector
 * @param[out] pDst        points to the output vector
 * @param[in]  numSamples  number of complex samples in each vector
 * @param[in]  isConj      conjugate enbale or disable
 */
void lsp_cmplx_mult_cmplx_int8(const int8_t *pSrcA, const int8_t *pSrcB, int16_t *pDst, uint32_t numSamples, uint8_t isConj);
 
/**
 * @brief  integer 16 complex-by-complex multiplication
 * @param[in]  pSrcA       points to the first input vector
 * @param[in]  pSrcB       points to the second input vector
 * @param[out] pDst        points to the output vector
 * @param[in]  numSamples  number of complex samples in each vector
 * @param[in]  isConj      conjugate enbale or disable
 */
void lsp_cmplx_mult_cmplx_int16(const int16_t *pSrcA, const int16_t *pSrcB, int32_t *pDst, uint32_t numSamples, uint8_t isConj);
 
/**
 * @brief  Floating-point complex-by-complex multiplication
 * @param[in]  pSrcA       points to the first input vector
 * @param[in]  pSrcB       points to the second input vector
 * @param[out] pDst        points to the output vector
 * @param[in]  numSamples  number of complex samples in each vector
 * @param[in]  isConj      conjugate enbale or disable
 */
void lsp_cmplx_mult_cmplx_f32(const float *pSrcA, const float *pSrcB, float *pDst, uint32_t numSamples, uint8_t isConj);
 
/**
 * @brief 8bit integer complex vector inner product, output integer format.
 * @param[in]  pSrcA        points to the first input vector
 * @param[in]  pSrcB        points to the second input vector
 * @param[out] pDst         points to the output vector
 * @param[in]  numSamples   number of complex samples in each vector
 * @param[in]  isConj       conjugate enbale or disable
 */
void lsp_cmplx_inner_product_int8(const int8_t *pSrcA, const int8_t *pSrcB, int32_t *pDst, uint32_t numSamples, uint8_t isConj);
 
/**
 * @brief 16bit integer complex vector inner product.
 * @param[in]  pSrcA        points to the first input vector
 * @param[in]  pSrcB        points to the second input vector
 * @param[out] pDst         points to the output vector
 * @param[in]  numSamples   number of complex samples in each vector
 * @param[in]  isConj       conjugate enbale or disable
 */
void lsp_cmplx_inner_product_int16(const int16_t *pSrcA, const int16_t *pSrcB, float *pDst, uint32_t numSamples, uint8_t isConj);
 
/**
 * @brief Floating-point complex vector inner product.
 * @param[in]  pSrcA        points to the first input vector
 * @param[in]  pSrcB        points to the second input vector
 * @param[out] pDst         points to the output vector
 * @param[in]  numSamples   number of complex samples in each vector
 * @param[in]  isConj       conjugate enbale or disable
 */
void lsp_cmplx_inner_product_f32(const float *pSrcA, const float *pSrcB, float *pDst, uint32_t numSamples, uint8_t isConj);
 
/**
 * @brief Multiplies a floating-point complex vector by a scalar.
 * @param[in]  pSrc       points to the input vector
 * @param[in]  re_scale   scale factor to be applied on real part
 * @param[in]  im_scale   scale factor to be applied on imaginary part
 * @param[out] pDst       points to the output vector
 * @param[in]  blkCnt     number of complex samples in the vector
 * @param[in]  isConj     conjugate enbale or disable
 */
void lsp_cmplx_scale_f32(const float *pSrc, float re_scale, float im_scale, float *pDst, uint32_t blkCnt, uint8_t isConj);
 
/**
 * @brief Floating-point matrix inverse.
 * @param[in]  pSrc     points to the instance of the input floating-point matrix structure.
 * @param[out] pDst     points to the instance of the output floating-point matrix structure.
 * @param[in]  rv       matrix regularization
 */
void lsp_cmplx_mat_inverse_f32(const struct LSP_MATRIX_T *pSrc, struct LSP_MATRIX_T *pDst, float rv);
 
/**
 * @brief Floating-point matrix LDL factorization.
 * @param[in]  pSrc     points to the instance of the input floating-point matrix structure.
 * @param[out] pDst     points to the instance of the output floating-point matrix structure.
 * @param[in]  rv       matrix regularization
 */
void lsp_cmplx_mat_ldl_f32(const struct LSP_MATRIX_T *pSrc, struct LSP_MATRIX_T *pDst, float rv);
 
/**
 * @brief Floating-point matrix multiplication
 * @param[in]  pSrcA     points to the first input matrix structure
 * @param[in]  pSrcB     points to the second input matrix structure
 * @param[out] pDst      points to output matrix structure
 */
void lsp_mat_mult_f32(const struct LSP_MATRIX_T *pSrcA, const struct LSP_MATRIX_T *pSrcB, struct LSP_MATRIX_T *pDst);
 
/**
 * @brief Floating-point complex matrix multiplication
 * @param[in]  pSrcA     points to the first input matrix structure
 * @param[in]  pSrcB     points to the second input matrix structure
 * @param[out] pDst      points to output matrix structure
 * @param[out] isConj    conjugate enbale or disable
 */
void lsp_cmplx_mat_mult_f32(const struct LSP_MATRIX_T *pSrcA, const struct LSP_MATRIX_T *pSrcB, struct LSP_MATRIX_T *pDst, uint8_t isConj);
 
#ifdef __cplusplus
}
#endif
 
/**
 * @}
 */
 
#endif /* MK_LSP_H_ */