xref: /aosp_15_r20/external/mesa3d/src/amd/vpelib/README.md (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1# VPE-LIB
2
3VPE C library for AMD drivers
4
5Folder Architecture
6===================
7```text
8[root]
9 |
10 +-- [inc]  ## public header to external modules
11 |
12 +-- [src]  ##internal implementation
13     |
14     +-- [chip]  ## store chip specific files
15     |    |
16     |    +-- [vpeXX]  ## asic specific files e.g. vpe10
17     |           |
18     |           +-- [inc]  ## all headers for vpe[XX]
19     |                 |
20     |                 +-- [asic]   ## store all headers that
21     |                              ## could conflict with headers in other asics
22     |                              ## src file has to explicitly include the files here
23     |                              ## without relying the compilation include directory path
24     |
25     |
26     + -- [core]  ## files that share for all asics
27     |    |
28     |    +-- [inc]  ## define the base functions that each vpe[xx] should implement
29     |
30     -- [utils]  ## utility functions like fixed point or u64 calculation
31          |
32          +-- [inc] ## utils headers
33```
34