-
Notifications
You must be signed in to change notification settings - Fork 364
Expand file tree
/
Copy pathcomponent.h
More file actions
1249 lines (1096 loc) · 38.4 KB
/
Copy pathcomponent.h
File metadata and controls
1249 lines (1096 loc) · 38.4 KB
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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* SPDX-License-Identifier: BSD-3-Clause
*
* Copyright(c) 2016 Intel Corporation. All rights reserved.
*
* Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
* Keyon Jie <yang.jie@linux.intel.com>
*/
/**
* \file include/sof/audio/component.h
* \brief Component API definition
* \author Liam Girdwood <liam.r.girdwood@linux.intel.com>
* \author Keyon Jie <yang.jie@linux.intel.com>
*/
#ifndef __SOF_AUDIO_COMPONENT_H__
#define __SOF_AUDIO_COMPONENT_H__
#include <sof/audio/buffer.h>
#include <sof/audio/format.h>
#include <sof/audio/pipeline.h>
#include <sof/debug/telemetry/telemetry.h>
#include <rtos/idc.h>
#include <rtos/mutex.h>
#include <rtos/userspace_helper.h>
#include <sof/lib/dai.h>
#include <sof/schedule/schedule.h>
#include <ipc/control.h>
#include <sof/ipc/topology.h>
#include <kernel/abi.h>
#include <limits.h>
struct comp_dev;
struct sof_ipc_stream_posn;
struct dai_hw_params;
struct timestamp_data;
struct dai_ts_data;
/** \addtogroup component_api Component API
* @{
*/
/* NOTE: Keep the component state diagram up to date:
* sof-docs/developer_guides/firmware/components/images/comp-dev-states.pu
*/
/** \name Audio Component States
* @{
*/
#define COMP_STATE_NOT_EXIST 0 /**< Component does not exist */
#define COMP_STATE_INIT 1 /**< Component being initialised */
#define COMP_STATE_READY 2 /**< Component inactive, but ready */
#define COMP_STATE_SUSPEND 3 /**< Component suspended */
#define COMP_STATE_PREPARE 4 /**< Component prepared */
#define COMP_STATE_PAUSED 5 /**< Component paused */
#define COMP_STATE_ACTIVE 6 /**< Component active */
#define COMP_STATE_PRE_ACTIVE 7 /**< Component after early initialisation */
/** @}*/
/** \name Standard Component Stream Commands
* TODO: use IPC versions after 1.1
*
* Most component stream commands match one-to-one IPC stream trigger commands.
* However we add two PRE_ and two POST_ commands to the set. They are issued
* internally without matching IPC commands. A single START IPC command is
* translated into a sequence of PRE_START and START component commands, etc.
* POST_* commands aren't used so far.
*
* @{
*/
enum {
COMP_TRIGGER_STOP, /**< Stop component stream */
COMP_TRIGGER_START, /**< Start component stream */
COMP_TRIGGER_PAUSE, /**< Pause the component stream */
COMP_TRIGGER_RELEASE, /**< Release paused component stream */
COMP_TRIGGER_RESET, /**< Reset component */
COMP_TRIGGER_PREPARE, /**< Prepare component */
COMP_TRIGGER_XRUN, /**< XRUN component */
COMP_TRIGGER_PRE_START, /**< Prepare to start component stream */
COMP_TRIGGER_PRE_RELEASE, /**< Prepare to release paused component stream */
COMP_TRIGGER_POST_STOP, /**< Finalize stop component stream */
COMP_TRIGGER_POST_PAUSE, /**< Finalize pause component stream */
COMP_TRIGGER_NO_ACTION, /**< No action required */
};
/** @}*/
/** \name Standard Component Control Commands
* "Value" commands are standard ones, known to the driver while
* "Data" commands are opaque blobs transferred by the driver.
*
* TODO: see also: ref to ipc data structures for commands.
* @{
*/
#define COMP_CMD_SET_VALUE 100 /**< Set value to component */
#define COMP_CMD_GET_VALUE 101 /**< Get value from component */
#define COMP_CMD_SET_DATA 102 /**< Set data to component */
#define COMP_CMD_GET_DATA 103 /**< Get data from component */
/** @}*/
/** \name MMAP IPC status
* @{
*/
#define COMP_CMD_IPC_MMAP_RPOS 200 /**< Host read position */
#define COMP_CMD_IPC_MMAP_PPOS 201 /**< DAI presentation position */
#define COMP_CMD_IPC_MMAP_VOL(chan) (216 + chan) /**< Volume */
/** @}*/
/** \name Component status
* @{
*/
#define COMP_STATUS_STATE_ALREADY_SET 1 /**< Comp set state status */
/** @}*/
/** \name Component attribute types
* @{
*/
#define COMP_ATTR_COPY_TYPE 0 /**< Comp copy type attribute */
#define COMP_ATTR_HOST_BUFFER 1 /**< Comp host buffer attribute */
#define COMP_ATTR_COPY_DIR 2 /**< Comp copy direction */
#define COMP_ATTR_VDMA_INDEX 3 /**< Comp index of the virtual DMA at the gateway. */
#define COMP_ATTR_BASE_CONFIG 4 /**< Component base config */
#define COMP_ATTR_IPC4_CONFIG 5 /**< Component ipc4 set/get config */
/** @}*/
/** \name Trace macros
* @{
*/
/** \brief Retrieves trace context from the component driver */
#define trace_comp_drv_get_tr_ctx(drv_p) ((drv_p)->tctx)
/** \brief Retrieves id (-1 = undefined) from the component driver */
#define trace_comp_drv_get_id(drv_p) (-1)
/** \brief Retrieves subid (-1 = undefined) from the component driver */
#define trace_comp_drv_get_subid(drv_p) (-1)
/** \brief Retrieves trace context from the component device */
#define trace_comp_get_tr_ctx(comp_p) (&(comp_p)->tctx)
/** \brief Retrieves id (pipe id) from the component device */
#define trace_comp_get_id(comp_p) ((comp_p)->ipc_config.pipeline_id)
/** \brief Retrieves subid (comp id) from the component device */
#define trace_comp_get_subid(comp_p) ((comp_p)->ipc_config.id)
#if defined(__ZEPHYR__) && defined(CONFIG_ZEPHYR_LOG)
/* class (driver) level (no device object) tracing */
#define comp_cl_err(drv_p, __e, ...) LOG_ERR(__e, ##__VA_ARGS__)
#define comp_cl_warn(drv_p, __e, ...) LOG_WRN(__e, ##__VA_ARGS__)
#define comp_cl_info(drv_p, __e, ...) LOG_INF(__e, ##__VA_ARGS__)
#define comp_cl_dbg(drv_p, __e, ...) LOG_DBG(__e, ##__VA_ARGS__)
/* device level tracing */
#if CONFIG_IPC_MAJOR_4
#define __COMP_FMT "comp:%u %#x "
#else
#define __COMP_FMT "comp:%u.%u "
#endif
#define comp_err(comp_p, __e, ...) LOG_ERR(__COMP_FMT __e, trace_comp_get_id(comp_p), \
trace_comp_get_subid(comp_p), ##__VA_ARGS__)
#define comp_warn(comp_p, __e, ...) LOG_WRN(__COMP_FMT __e, trace_comp_get_id(comp_p), \
trace_comp_get_subid(comp_p), ##__VA_ARGS__)
#define comp_info(comp_p, __e, ...) LOG_INF(__COMP_FMT __e, trace_comp_get_id(comp_p), \
trace_comp_get_subid(comp_p), ##__VA_ARGS__)
#define comp_dbg(comp_p, __e, ...) LOG_DBG(__COMP_FMT __e, trace_comp_get_id(comp_p), \
trace_comp_get_subid(comp_p), ##__VA_ARGS__)
#else
/* class (driver) level (no device object) tracing */
/** \brief Trace error message from component driver (no comp instance) */
#define comp_cl_err(drv_p, __e, ...) \
trace_dev_err(trace_comp_drv_get_tr_ctx, \
trace_comp_drv_get_id, \
trace_comp_drv_get_subid, \
drv_p, \
__e, ##__VA_ARGS__)
/** \brief Trace warning message from component driver (no comp instance) */
#define comp_cl_warn(drv_p, __e, ...) \
trace_dev_warn(trace_comp_drv_get_tr_ctx, \
trace_comp_drv_get_id, \
trace_comp_drv_get_subid, \
drv_p, \
__e, ##__VA_ARGS__)
/** \brief Trace info message from component driver (no comp instance) */
#define comp_cl_info(drv_p, __e, ...) \
trace_dev_info(trace_comp_drv_get_tr_ctx, \
trace_comp_drv_get_id, \
trace_comp_drv_get_subid, \
drv_p, \
__e, ##__VA_ARGS__)
/** \brief Trace debug message from component driver (no comp instance) */
#define comp_cl_dbg(drv_p, __e, ...) \
trace_dev_dbg(trace_comp_drv_get_tr_ctx, \
trace_comp_drv_get_id, \
trace_comp_drv_get_subid, \
drv_p, \
__e, ##__VA_ARGS__)
/* device tracing */
/** \brief Trace error message from component device */
#define comp_err(comp_p, __e, ...) \
trace_dev_err(trace_comp_get_tr_ctx, trace_comp_get_id, \
trace_comp_get_subid, comp_p, __e, ##__VA_ARGS__)
/** \brief Trace warning message from component device */
#define comp_warn(comp_p, __e, ...) \
trace_dev_warn(trace_comp_get_tr_ctx, trace_comp_get_id, \
trace_comp_get_subid, comp_p, __e, ##__VA_ARGS__)
/** \brief Trace info message from component device */
#define comp_info(comp_p, __e, ...) \
trace_dev_info(trace_comp_get_tr_ctx, trace_comp_get_id, \
trace_comp_get_subid, comp_p, __e, ##__VA_ARGS__)
/** \brief Trace debug message from component device */
#define comp_dbg(comp_p, __e, ...) \
trace_dev_dbg(trace_comp_get_tr_ctx, trace_comp_get_id, \
trace_comp_get_subid, comp_p, __e, ##__VA_ARGS__)
#endif /* #if defined(__ZEPHYR__) && defined(CONFIG_ZEPHYR_LOG) */
#define comp_perf_info(pcd, comp_p) \
comp_info(comp_p, "perf comp_copy peak plat %u cpu %u", \
(uint32_t)((pcd)->plat_delta_peak), \
(uint32_t)((pcd)->cpu_delta_peak))
#define comp_perf_avg_info(pcd, comp_p) \
comp_info(comp_p, "perf comp_copy samples %u period %u cpu avg %u peak %u %u",\
(uint32_t)((comp_p)->frames), \
(uint32_t)((comp_p)->period), \
(uint32_t)((pcd)->cpu_delta_sum), \
(uint32_t)((pcd)->cpu_delta_peak), \
(uint32_t)((pcd)->peak_mcps_period_cnt))
/** @}*/
/** \brief Type of endpoint this component is connected to in a pipeline */
enum comp_endpoint_type {
COMP_ENDPOINT_HOST, /**< Connected to host dma */
COMP_ENDPOINT_DAI, /**< Connected to dai dma */
COMP_ENDPOINT_NODE /**< No dma connection */
};
/**
* \brief Type of next dma copy mode, changed on runtime.
*
* Supported by host as COMP_ATTR_COPY_TYPE parameter
* to comp_set_attribute().
*/
enum comp_copy_type {
COMP_COPY_INVALID = -1, /**< Invalid */
COMP_COPY_NORMAL = 0, /**< Normal */
COMP_COPY_BLOCKING, /**< Blocking */
COMP_COPY_ONE_SHOT, /**< One-shot */
};
struct comp_driver;
struct comp_ipc_config;
union ipc_config_specific;
struct ipc4_module_bind_unbind;
enum bind_type {
COMP_BIND_TYPE_SOURCE,
COMP_BIND_TYPE_SINK
};
struct bind_info {
/* pointer to IPC4 bind/unbind data */
struct ipc4_module_bind_unbind *ipc4_data;
/* type of binding
* bind call will be called twice for every component, first when binding a data source,
* than when binding data sink.
*
* bind_type is indicating type of binding
*/
enum bind_type bind_type;
/* pointers to sink or source API of the data provider/consumer
* that is being bound to the module
*
* if bind_type == COMP_BIND_TYPE_SOURCE, the pointer points to source being bound/unbound
* if bind_type == COMP_BIND_TYPE_SINK, the pointer points to sink being bound/unbound
*
* NOTE! As in pipeline2.0 there may be a binding between modules,
* without a buffer in between, it cannot be a pointer to any buffer type, module should
* use sink/source API
*/
union {
struct sof_source *source;
struct sof_sink *sink;
};
};
/**
* Audio component operations.
*
* All component operations must return 0 for success, negative values for
* errors and 1 to stop the pipeline walk operation unless specified otherwise
* in the operation documentation.
*/
struct comp_ops {
/**
* Creates a new component device.
* @param drv Parent component driver.
* @param ipc_config Component parameters.
* @param spec Pointer to initialization data
* @return Pointer to the new component device.
*
* Any component-specific private data is allocated separately and
* pointer is connected to the comp_dev::private by using
* comp_set_drvdata() and later retrieved by comp_get_drvdata().
*
* All parameters should be initialized to their default values.
* Usually can be __cold.
*/
struct comp_dev *(*create)(const struct comp_driver *drv,
const struct comp_ipc_config *ipc_config,
const void *spec);
/**
* Called to delete the specified component device.
* @param dev Component device to be deleted.
*
* All data structures previously allocated on the run-time heap
* must be freed by the implementation of <code>free()</code>.
* Usually can be __cold.
*/
void (*free)(struct comp_dev *dev);
/**
* Sets component audio stream parameters.
* @param dev Component device.
* @param params Audio (PCM) stream parameters to be set.
*
* Infrastructure calls comp_verify_params() if this handler is not
* defined, therefore it should be left NULL if no extra steps are
* required.
* Usually shouldn't be __cold.
*/
int (*params)(struct comp_dev *dev,
struct sof_ipc_stream_params *params);
/**
* Fetches hardware stream parameters.
* @param dev Component device.
* @param params Receives copy of stream parameters retrieved from
* DAI hw settings.
* @param dir Stream direction (see enum sof_ipc_stream_direction).
*
* Mandatory for components that allocate DAI.
* Usually can be __cold.
*/
int (*dai_get_hw_params)(struct comp_dev *dev,
struct sof_ipc_stream_params *params, int dir);
/**
* Configures attached DAI.
* @param dev Component device.
* @param dai_config DAI configuration.
*
* Mandatory for components that allocate DAI.
* Usually can be __cold.
*/
int (*dai_config)(struct dai_data *dd, struct comp_dev *dev,
struct ipc_config_dai *dai_config, const void *dai_spec_config);
#if CONFIG_IPC_MAJOR_3 || CONFIG_LIBRARY
/**
* Used to pass standard and bespoke commands (with optional data).
* @param dev Component device.
* @param cmd Command.
* @param data Command data.
* @param max_data_size Max size of returned data acceptable by the
* caller in case of 'get' commands.
*/
int (*cmd)(struct comp_dev *dev, int cmd, void *data,
int max_data_size);
#endif
/**
* Trigger, atomic - used to start/stop/pause stream operations.
* @param dev Component device.
* @param cmd Command, one of COMP_TRIGGER_...
*
* Usually shouldn't be __cold.
*/
int (*trigger)(struct comp_dev *dev, int cmd);
/**
* Prepares component after params are set.
* @param dev Component device.
*
* Prepare should be used to get the component ready for starting
* processing after it's hw_params are known or after an XRUN.
* Usually shouldn't be __cold.
*/
int (*prepare)(struct comp_dev *dev);
/**
* Resets component.
* @param dev Component device.
*
* Resets the component state and any hw_params to default component
* state. Should also free any resources acquired during hw_params.
* Usually shouldn't be __cold.
*/
int (*reset)(struct comp_dev *dev);
/**
* Copy and process stream data from source to sink buffers.
* @param dev Component device.
* @return Number of copied frames.
*
* Usually shouldn't be __cold.
*/
int (*copy)(struct comp_dev *dev);
/**
* Retrieves component rendering position.
* @param dev Component device.
* @param posn Receives reported position.
*
* Usually shouldn't be __cold.
*/
int (*position)(struct comp_dev *dev,
struct sof_ipc_stream_posn *posn);
/**
* Gets attribute in component.
* @param dev Component device.
* @param type Attribute type.
* @param value Attribute value.
* @return 0 if succeeded, error code otherwise.
*
* Usually can be __cold.
*/
int (*get_attribute)(struct comp_dev *dev, uint32_t type,
void *value);
/**
* Sets attribute in component.
* @param dev Component device.
* @param type Attribute type.
* @param value Attribute value.
* @return 0 if succeeded, error code otherwise.
*
* Usually can be __cold.
*/
int (*set_attribute)(struct comp_dev *dev, uint32_t type,
void *value);
/**
* Configures timestamping in attached DAI.
* @param dev Component device.
*
* Mandatory for components that allocate DAI.
* Usually can be __cold.
*/
int (*dai_ts_config)(struct comp_dev *dev);
/**
* Starts timestamping.
* @param dev Component device.
*
* Mandatory for components that allocate DAI.
* Usually can be __cold.
*/
int (*dai_ts_start)(struct comp_dev *dev);
/**
* Stops timestamping.
* @param dev Component device.
*
* Mandatory for components that allocate DAI.
* Usually can be __cold.
*/
int (*dai_ts_stop)(struct comp_dev *dev);
/**
* Gets timestamp.
* @param dev Component device.
* @param tsd Receives timestamp data.
*
* Mandatory for components that allocate DAI.
* Usually shouldn't be __cold.
*/
#if CONFIG_ZEPHYR_NATIVE_DRIVERS
int (*dai_ts_get)(struct comp_dev *dev, struct dai_ts_data *tsd);
#else
int (*dai_ts_get)(struct comp_dev *dev,
struct timestamp_data *tsd);
#endif
/**
* Bind, atomic - used to notify component of bind event.
* @param dev Component device.
* @param data Bind info
*
* Usually can be __cold.
*/
int (*bind)(struct comp_dev *dev, struct bind_info *bind_data);
/**
* Unbind, atomic - used to notify component of unbind event.
* @param dev Component device.
* @param data unBind info
*
* Usually can be __cold.
*/
int (*unbind)(struct comp_dev *dev, struct bind_info *unbind_data);
/**
* Gets config in component.
* @param dev Component device
* @param param_id param id for each component
* @param first_block first block of large block.
* @param last_block last block of large block.
* @param data_offset block offset filled by callee.
* @param data block data.
* @return 0 if succeeded, error code otherwise.
*
* Callee fills up *data with config data and save the config
* size in *data_offset for host to reconstruct the config
* Usually can be __cold.
*/
int (*get_large_config)(struct comp_dev *dev, uint32_t param_id,
bool first_block,
bool last_block,
uint32_t *data_offset,
char *data);
/**
* Set config in component.
* @param dev Component device
* @param param_id param id for each component
* @param first_block first block of large block.
* @param last_block last block of large block.
* @param data_offset block offset in large block.
* @param data block data.
* @return 0 if succeeded, error code otherwise.
*
* Host divides large block into small blocks and sends them
* to fw. The data_offset indicates the offset in the large
* block data.
* Usually can be __cold.
*/
int (*set_large_config)(struct comp_dev *dev, uint32_t param_id,
bool first_block,
bool last_block,
uint32_t data_offset,
const char *data);
/**
* Returns total data processed in number bytes.
* @param dev Component device
* @param stream_no Index of input/output stream
* @param input Selects between input (true) or output (false) stream direction
* @return total data processed if succeeded, 0 otherwise.
*
* Usually shouldn't be __cold.
*/
uint64_t (*get_total_data_processed)(struct comp_dev *dev, uint32_t stream_no, bool input);
};
/**
* Audio component base driver "class"
* - used by all other component types.
*/
struct comp_driver {
uint32_t type; /**< SOF_COMP_ for driver */
const struct sof_uuid *uid; /**< Address to UUID value */
struct tr_ctx *tctx; /**< Pointer to trace context */
struct comp_ops ops; /**< component operations */
const struct module_interface *adapter_ops; /**< module specific operations.
* Intended to replace the ops field.
* Currently used by module_adapter.
*/
struct k_heap *user_heap; /**< Userspace heap */
};
/** \brief Holds constant pointer to component driver */
struct comp_driver_info {
const struct comp_driver *drv; /**< pointer to component driver */
const struct module_interface **adapter_ops; /**< pointer for updating ops */
struct list_item list; /**< list of component drivers */
};
#define COMP_PROCESSING_DOMAIN_LL 0
#define COMP_PROCESSING_DOMAIN_DP 1
/**
* Audio component base configuration from IPC at creation.
*/
struct comp_ipc_config {
uint32_t core; /**< core we run on */
uint32_t id; /**< component id */
uint32_t pipeline_id; /**< component pipeline id */
uint32_t proc_domain; /**< processing domain - LL or DP */
enum sof_comp_type type; /**< component type */
uint32_t periods_sink; /**< 0 means variable */
uint32_t periods_source; /**< 0 means variable */
uint32_t frame_fmt; /**< SOF_IPC_FRAME_ */
uint32_t xrun_action; /**< action we should take on XRUN */
#if CONFIG_IPC_MAJOR_4
bool ipc_extended_init; /**< true if extended init is included in ipc payload */
uint32_t ipc_config_size; /**< size of a config received by ipc */
#endif
};
struct comp_perf_data {
/* maximum measured cpc on run-time.
*
* if current measured cpc exceeds peak_of_measured_cpc_ then
* ResoruceEvent(BUDGET_VIOLATION) notification must be send.
* Otherwise there is no new information for host to care about
*/
size_t peak_of_measured_cpc;
/* Pointer to performance data structure. */
struct perf_data_item_comp *perf_data_item;
};
/**
* Audio component base device "class"
* - used by other component types.
*/
struct comp_dev {
/* runtime */
uint16_t state; /**< COMP_STATE_ */
uint32_t frames; /**< number of frames we copy to sink */
struct pipeline *pipeline; /**< pipeline we belong to */
struct task *task; /**< component's processing task used
* 1) for components running on different core
* than the rest of the pipeline
* 2) for all DP tasks
*/
uint32_t size; /**< component's allocated size */
uint32_t period; /**< component's processing period
* for LL modules is set to LL pipeline's period
* for DP module its meaning is "the time the module MUST
* provide data that allows the following module to perform
* without glitches"
*/
uint32_t priority; /**< component's processing priority */
bool is_shared; /**< indicates whether component is shared
* across cores
*/
struct comp_ipc_config ipc_config; /**< Component IPC configuration */
struct tr_ctx tctx; /**< trace settings */
/* common runtime configuration for downstream/upstream */
uint32_t direction; /**< enum sof_ipc_stream_direction */
bool direction_set; /**< flag indicating that the direction has been set */
const struct comp_driver *drv; /**< driver */
struct processing_module *mod; /**< self->mod->dev == self, NULL if component is not using
* module adapter
*/
/* lists */
struct list_item bsource_list; /**< list of source buffers */
struct list_item bsink_list; /**< list of sink buffers */
#ifdef CONFIG_SOF_USERSPACE_LL
struct sys_mutex list_mutex; /**< protect lists of source/sinks */
#endif
/* performance data*/
struct comp_perf_data perf_data;
/* Input Buffer Size for pin 0, add array for other pins if needed */
size_t ibs;
/* Output Buffers Size for pin 0, add array for other pins if needed */
size_t obs;
/* max dsp cycles per chunk */
size_t cpc;
/* size of 1ms for input format in bytes */
size_t ll_chunk_size : 16;
/* private data - core does not touch this */
void *priv_data; /**< private data */
#if CONFIG_PERFORMANCE_COUNTERS_COMPONENT
struct perf_cnt_data pcd;
#endif
#if CONFIG_KCPS_DYNAMIC_CLOCK_CONTROL
int32_t kcps_inc[CONFIG_CORE_COUNT];
#endif
};
/**
* Get a pointer to the first comp_buffer object providing data to the component
* The function will return NULL if there's no data provider
*/
static inline struct comp_buffer *comp_dev_get_first_data_producer(struct comp_dev *component)
{
return list_is_empty(&component->bsource_list) ? NULL :
list_first_item(&component->bsource_list, struct comp_buffer, sink_list);
}
/**
* Get a pointer to the next comp_buffer object providing data to the component
* The function will return NULL if there're no more data providers
* _save version also checks if producer != NULL
*/
static inline struct comp_buffer *comp_dev_get_next_data_producer(struct comp_dev *component,
struct comp_buffer *producer)
{
return producer->sink_list.next == &component->bsource_list ? NULL :
list_item(producer->sink_list.next, struct comp_buffer, sink_list);
}
static inline struct comp_buffer *comp_dev_get_next_data_producer_safe(struct comp_dev *component,
struct comp_buffer *producer)
{
return producer ? comp_dev_get_next_data_producer(component, producer) : NULL;
}
/**
* Get a pointer to the first comp_buffer object receiving data from the component
* The function will return NULL if there's no data consumers
*/
static inline struct comp_buffer *comp_dev_get_first_data_consumer(struct comp_dev *component)
{
return list_is_empty(&component->bsink_list) ? NULL :
list_first_item(&component->bsink_list, struct comp_buffer, source_list);
}
/**
* Get a pointer to the next comp_buffer object receiving data from the component
* The function will return NULL if there're no more data consumers
* _safe version also checks if consumer is != NULL
*/
static inline struct comp_buffer *comp_dev_get_next_data_consumer(struct comp_dev *component,
struct comp_buffer *consumer)
{
return consumer->source_list.next == &component->bsink_list ? NULL :
list_item(consumer->source_list.next, struct comp_buffer, source_list);
}
static inline struct comp_buffer *comp_dev_get_next_data_consumer_safe(struct comp_dev *component,
struct comp_buffer *consumer)
{
return consumer ? comp_dev_get_next_data_consumer(component, consumer) : NULL;
}
/*
* a macro for easy iteration through component's list of producers
*/
#define comp_dev_for_each_producer(_dev, _producer) \
for (_producer = comp_dev_get_first_data_producer(_dev); \
_producer != NULL; \
_producer = comp_dev_get_next_data_producer(_dev, _producer))
/*
* a macro for easy iteration through component's list of producers
* allowing deletion of a buffer during iteration
*
* additional "safe storage" pointer to struct comp_buffer must be provided
*/
#define comp_dev_for_each_producer_safe(_dev, _producer, _next_producer) \
for (_producer = comp_dev_get_first_data_producer(_dev), \
_next_producer = comp_dev_get_next_data_producer_safe(_dev, _producer); \
_producer != NULL; \
_producer = _next_producer, \
_next_producer = comp_dev_get_next_data_producer_safe(_dev, _producer))
/*
* a macro for easy iteration through component's list of consumers
*/
#define comp_dev_for_each_consumer(_dev, _consumer) \
for (_consumer = comp_dev_get_first_data_consumer(_dev); \
_consumer != NULL; \
_consumer = comp_dev_get_next_data_consumer(_dev, _consumer)) \
/*
* a macro for easy iteration through component's list of consumers
* allowing deletion of a buffer during iteration
*
* additional "safe storage" pointer to struct comp_buffer must be provided
*/
#define comp_dev_for_each_consumer_safe(_dev, _consumer, _next_consumer) \
for (_consumer = comp_dev_get_first_data_consumer(_dev), \
_next_consumer = comp_dev_get_next_data_consumer_safe(_dev, _consumer); \
_consumer != NULL; \
_consumer = _next_consumer, \
_next_consumer = comp_dev_get_next_data_consumer_safe(_dev, _consumer))
/** @}*/
/* Common helper function used internally by the component implementations
* begin here.
*/
/** \addtogroup component_common_int Component's Common Helpers
* @{
*/
/** \brief Struct for use with comp_get_copy_limits() function. */
struct comp_copy_limits {
int frames;
int source_bytes;
int sink_bytes;
int source_frame_bytes;
int sink_frame_bytes;
};
/**
* Retrieves Component id from device.
* @param dev Device.
* @return Component id.
*/
static inline uint32_t dev_comp_id(const struct comp_dev *dev)
{
return dev->ipc_config.id;
}
/**
* Retrieves Component pipeline id from device.
* @param dev Device.
* @return Component pipeline id.
*/
static inline uint32_t dev_comp_pipe_id(const struct comp_dev *dev)
{
return dev->ipc_config.pipeline_id;
}
/**
* Retrieves component type from device.
* @param dev Device.
* @return Component type.
*/
static inline enum sof_comp_type dev_comp_type(const struct comp_dev *dev)
{
return dev->ipc_config.type;
}
/**
* Initialize common part of a component device
* @param drv Parent component driver.
* @param dev Device.
* @param bytes Size of the component device in bytes.
*/
static inline void comp_init(const struct comp_driver *drv,
struct comp_dev *dev, size_t bytes)
{
dev->size = bytes;
dev->drv = drv;
dev->state = COMP_STATE_INIT;
list_init(&dev->bsink_list);
list_init(&dev->bsource_list);
#ifdef CONFIG_SOF_USERSPACE_LL
sys_mutex_init(&dev->list_mutex);
#endif
#ifndef __ZEPHYR__
memcpy_s(&dev->tctx, sizeof(dev->tctx),
trace_comp_drv_get_tr_ctx(dev->drv), sizeof(struct tr_ctx));
#endif
}
/**
* Allocates memory for the component device and initializes common part.
* @param drv Parent component driver.
* @param bytes Size of the component device in bytes.
* @return Pointer to the component device.
*/
static inline struct comp_dev *comp_alloc(const struct comp_driver *drv, size_t bytes)
{
/*
* Use uncached address everywhere to access components to rule out
* multi-core failures. TODO: verify if cached alias may be used in some cases
*/
struct comp_dev *dev = sof_heap_alloc(drv->user_heap,
SOF_MEM_FLAG_USER | SOF_MEM_FLAG_COHERENT,
bytes, 0);
if (!dev)
return NULL;
memset(dev, 0, sizeof(*dev));
comp_init(drv, dev, bytes);
return dev;
}
/**
* Frees memory allocated for component device.
*
* This is a counterpart to comp_alloc() and not to be confused with
* comp_free().
*
* @param dev Pointer to the component device.
*/
static inline void comp_free_device(struct comp_dev *dev)
{
sof_heap_free(dev->drv->user_heap, dev);
}
/**
* \brief Module adapter associated with a component
* @param dev Component device
*/
static inline struct processing_module *comp_mod(const struct comp_dev *dev)
{
return dev->mod;
}
/**
* \brief Assigns private data to component device.
* @param c Component device.
* @param data Private data.
*/
#define comp_set_drvdata(c, data) \
(c->priv_data = data)
/**
* \brief Retrieves driver private data from component device.
* @param c Component device.
* @return Private data.
*/
#define comp_get_drvdata(c) \
(c->priv_data)
#if defined UNIT_TEST || defined __ZEPHYR__ || CONFIG_LIBRARY_STATIC
#define DECLARE_MODULE(init)
/* declared modules */
void sys_comp_dai_init(void);
void sys_comp_host_init(void);
void sys_comp_kpb_init(void);
void sys_comp_selector_init(void);
/* Start of modules in alphabetical order */
void sys_comp_module_aria_interface_init(void);
void sys_comp_module_asrc_interface_init(void);
void sys_comp_module_copier_interface_init(void);
void sys_comp_module_crossover_interface_init(void);
void sys_comp_module_dcblock_interface_init(void);
void sys_comp_module_demux_interface_init(void);
void sys_comp_module_dolby_dax_audio_processing_interface_init(void);
void sys_comp_module_drc_interface_init(void);
void sys_comp_module_dts_interface_init(void);
void sys_comp_module_eq_fir_interface_init(void);
void sys_comp_module_eq_iir_interface_init(void);
void sys_comp_module_gain_interface_init(void);
void sys_comp_module_google_rtc_audio_processing_interface_init(void);
void sys_comp_module_google_ctc_audio_processing_interface_init(void);
void sys_comp_module_igo_nr_interface_init(void);
void sys_comp_module_level_multiplier_interface_init(void);
void sys_comp_module_mfcc_interface_init(void);
void sys_comp_module_mixer_interface_init(void);
void sys_comp_module_mixin_interface_init(void);
void sys_comp_module_mixout_interface_init(void);
void sys_comp_module_multiband_drc_interface_init(void);
void sys_comp_module_mux_interface_init(void);
void sys_comp_module_nxp_eap_interface_init(void);
void sys_comp_module_rtnr_interface_init(void);
void sys_comp_module_selector_interface_init(void);
void sys_comp_module_sound_dose_interface_init(void);
void sys_comp_module_src_interface_init(void);
void sys_comp_module_src_lite_interface_init(void);
void sys_comp_module_stft_process_interface_init(void);
void sys_comp_module_tdfb_interface_init(void);
void sys_comp_module_tone_interface_init(void);
void sys_comp_module_template_interface_init(void);
void sys_comp_module_tester_interface_init(void);
void sys_comp_module_volume_interface_init(void);
/* End of modules in alphabetical order */
#elif CONFIG_LIBRARY
/* In case of shared libs components are initialised in dlopen */
#define DECLARE_MODULE(init) __attribute__((constructor)) \
static void _module_##init(void) { init(); }
#else
/** \brief Usage at the end of an independent module file:
* DECLARE_MODULE(sys_*_init);
*/
#define DECLARE_MODULE(init) __attribute__((__used__)) \
__section(".initcall") static void(*f##init)(void) = init
#endif