pax_global_header00006660000000000000000000000064152074742600014521gustar00rootroot0000000000000052 comment=7b83853dce5b8e0be4db11076807c9f402139506 intel-igsc-7b83853/000077500000000000000000000000001520747426000140445ustar00rootroot00000000000000intel-igsc-7b83853/.bdsignore.all000066400000000000000000000002301520747426000165630ustar00rootroot00000000000000.bdsignore.all protex/* doc/* README.md CHANGELOG.md .editorconfig .git .gitlint .gitignore .gitattributes .gitlab-ci/* .gitlab-ci.yml .cmake-format.py intel-igsc-7b83853/.cmake-format.py000066400000000000000000000167061520747426000170540ustar00rootroot00000000000000# ---------------------------------- # Options affecting listfile parsing # ---------------------------------- with section("parse"): # Specify structure for custom cmake functions additional_commands = { 'format_and_lint': { 'kwargs': { 'CC': '*', 'CCDEPENDS': '*', 'CMAKE': '*', 'EXCLUDE': '*', 'JS': '*', 'PY': '*'}}, 'pkg_find': {'kwargs': {'PKG': '*'}}} # Specify variable tags. vartags = [] # Specify property tags. proptags = [] # ----------------------------- # Options affecting formatting. # ----------------------------- with section("format"): # How wide to allow formatted cmake files line_width = 80 # How many spaces to tab for indent tab_size = 2 # If an argument group contains more than this many sub-groups (parg or kwarg # groups) then force it to a vertical layout. max_subgroups_hwrap = 2 # If a positional argument group contains more than this many arguments, then # force it to a vertical layout. max_pargs_hwrap = 6 # If a cmdline positional group consumes more than this many lines without # nesting, then invalidate the layout (and nest) max_rows_cmdline = 2 # If true, separate flow control names from their parentheses with a space separate_ctrl_name_with_space = False # If true, separate function names from parentheses with a space separate_fn_name_with_space = False # If a statement is wrapped to more than one line, than dangle the closing # parenthesis on its own line. dangle_parens = False # If the trailing parenthesis must be 'dangled' on its on line, then align it # to this reference: `prefix`: the start of the statement, `prefix-indent`: # the start of the statement, plus one indentation level, `child`: align to # the column of the arguments dangle_align = 'prefix' # If the statement spelling length (including space and parenthesis) is # smaller than this amount, then force reject nested layouts. min_prefix_chars = 4 # If the statement spelling length (including space and parenthesis) is larger # than the tab width by more than this amount, then force reject un-nested # layouts. max_prefix_chars = 10 # If a candidate layout is wrapped horizontally but it exceeds this many # lines, then reject the layout. max_lines_hwrap = 2 # What style line endings to use in the output. line_ending = 'unix' # Format command names consistently as 'lower' or 'upper' case command_case = 'canonical' # Format keywords consistently as 'lower' or 'upper' case keyword_case = 'unchanged' # A list of command names which should always be wrapped always_wrap = [] # If true, the argument lists which are known to be sortable will be sorted # lexicographicall enable_sort = True # If true, the parsers may infer whether or not an argument list is sortable # (without annotation). autosort = False # By default, if cmake-format cannot successfully fit everything into the # desired linewidth it will apply the last, most aggressive attempt that it # made. If this flag is True, however, cmake-format will print error, exit # with non-zero status code, and write-out nothing require_valid_layout = False # A dictionary mapping layout nodes to a list of wrap decisions. See the # documentation for more information. layout_passes = {} # ------------------------------------------------ # Options affecting comment reflow and formatting. # ------------------------------------------------ with section("markup"): # What character to use for bulleted lists bullet_char = '*' # What character to use as punctuation after numerals in an enumerated list enum_char = '.' # If comment markup is enabled, don't reflow the first comment block in each # listfile. Use this to preserve formatting of your copyright/license # statements. first_comment_is_literal = False # If comment markup is enabled, don't reflow any comment block which matches # this (regex) pattern. Default is `None` (disabled). literal_comment_pattern = None # Regular expression to match preformat fences in comments default= # ``r'^\s*([`~]{3}[`~]*)(.*)$'`` fence_pattern = '^\\s*([`~]{3}[`~]*)(.*)$' # Regular expression to match rulers in comments default= # ``r'^\s*[^\w\s]{3}.*[^\w\s]{3}$'`` ruler_pattern = '^\\s*[^\\w\\s]{3}.*[^\\w\\s]{3}$' # If a comment line matches starts with this pattern then it is explicitly a # trailing comment for the preceding argument. Default is '#<' explicit_trailing_pattern = '#<' # If a comment line starts with at least this many consecutive hash # characters, then don't lstrip() them off. This allows for lazy hash rulers # where the first hash char is not separated by space hashruler_min_length = 10 # If true, then insert a space between the first hash char and remaining hash # chars in a hash ruler, and normalize its length to fill the column canonicalize_hashrulers = True # enable comment markup parsing and reflow enable_markup = True # ---------------------------- # Options affecting the linter # ---------------------------- with section("lint"): # a list of lint codes to disable disabled_codes = ['E1122', 'C0113'] # regular expression pattern describing valid function names function_pattern = '[0-9a-z_]+' # regular expression pattern describing valid macro names macro_pattern = '[0-9A-Z_]+' # regular expression pattern describing valid names for variables with global # scope global_var_pattern = '[0-9a-zA-Z][0-9a-zA-Z_]+' # regular expression pattern describing valid names for variables with global # scope (but internal semantic) internal_var_pattern = '_[0-9A-Z][0-9A-Z_]+' # regular expression pattern describing valid names for variables with local # scope local_var_pattern = '[0-9a-z_]+' # regular expression pattern describing valid names for privatedirectory # variables private_var_pattern = '_[0-9a-z_]+' # regular expression pattern describing valid names for publicdirectory # variables public_var_pattern = '[0-9A-Z][0-9A-Z_]+' # regular expression pattern describing valid names for keywords used in # functions or macros keyword_pattern = '[0-9A-Z_]+' # In the heuristic for C0201, how many conditionals to match within a loop in # before considering the loop a parser. max_conditionals_custom_parser = 2 # Require at least this many newlines between statements min_statement_spacing = 1 # Require no more than this many newlines between statements max_statement_spacing = 3 max_returns = 6 max_branches = 12 max_arguments = 5 max_localvars = 15 max_statements = 50 # ------------------------------- # Options affecting file encoding # ------------------------------- with section("encode"): # If true, emit the unicode byte-order mark (BOM) at the start of the file emit_byteorder_mark = False # Specify the encoding of the input file. Defaults to utf-8 input_encoding = 'utf-8' # Specify the encoding of the output file. Defaults to utf-8. Note that cmake # only claims to support utf-8 so be careful when using anything else output_encoding = 'utf-8' # ------------------------------------- # Miscellaneous configurations options. # ------------------------------------- with section("misc"): # A dictionary containing any per-command configuration overrides. Currently # only `command_case` is supported. per_command = {} intel-igsc-7b83853/.codespell-whitelist000066400000000000000000000000001520747426000200170ustar00rootroot00000000000000intel-igsc-7b83853/.codespellrc000066400000000000000000000001631520747426000163440ustar00rootroot00000000000000[codespell] quiet-level = 38 skip = .git,*.svg,*.png,*.dat,./codespell.log,**/metee/** ignore-words-list = FPT,fpt intel-igsc-7b83853/.editorconfig000066400000000000000000000007721520747426000165270ustar00rootroot00000000000000# SPDX-License-Identifier: Apache-2.0 # Copyright (C) 2020 Intel Corporation # To use this config with your editor, follow the instructions at: # http://editorconfig.org root = true [*] charset = utf-8 insert_final_newline = false [*.{c,h}] indent_style = space indent_size = 4 [{Makefile.*,*.mk}] indent_style = tab [*.m4] indent_style = space indent_size = 2 [{meson.build,meson_options.txt}] indent_style = space indent_size = 2 [{CMakeLists.txt, *.cmake}] indent_style = space indent_size = 4 intel-igsc-7b83853/.gitattributes000066400000000000000000000001661520747426000167420ustar00rootroot00000000000000* text=auto *.svg text *.png binary # Don't export CI files .gitlab-ci.yml export-ignore .gitlab-ci export-ignore intel-igsc-7b83853/.gitignore000066400000000000000000000150741520747426000160430ustar00rootroot00000000000000## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. ## ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore # User-specific files *.rsuser *.suo *.user *.userosscache *.sln.docstates # User-specific files (MonoDevelop/Xamarin Studio) *.userprefs # Mono auto generated files mono_crash.* # Build results [Dd]ebug/ [Dd]ebugPublic/ [Rr]elease/ [Rr]eleases/ x64/ x86/ [Ww][Ii][Nn]32/ [Aa][Rr][Mm]/ [Aa][Rr][Mm]64/ bld/ [Bb]in/ [Oo]bj/ [Ll]og/ [Ll]ogs/ # Visual Studio 2015/2017 cache/options directory .vs/ # Uncomment if you have tasks that create the project's static files in wwwroot #wwwroot/ # Visual Studio 2017 auto generated files Generated\ Files/ # MSTest test Results [Tt]est[Rr]esult*/ [Bb]uild[Ll]og.* # NUnit *.VisualState.xml TestResult.xml nunit-*.xml # Build Results of an ATL Project [Dd]ebugPS/ [Rr]eleasePS/ dlldata.c # Benchmark Results BenchmarkDotNet.Artifacts/ # .NET Core project.lock.json project.fragment.lock.json artifacts/ # ASP.NET Scaffolding ScaffoldingReadMe.txt # StyleCop StyleCopReport.xml # Files built by Visual Studio *_i.c *_p.c *_h.h *.ilk *.meta *.obj *.iobj *.pch *.pdb *.ipdb *.pgc *.pgd *.rsp *.sbr *.tlb *.tli *.tlh *.tmp *.tmp_proj *_wpftmp.csproj *.log *.tlog *.vspscc *.vssscc .builds *.pidb *.svclog *.scc # Chutzpah Test files _Chutzpah* # Visual C++ cache files ipch/ *.aps *.ncb *.opendb *.opensdf *.sdf *.cachefile *.VC.db *.VC.VC.opendb # Visual Studio profiler *.psess *.vsp *.vspx *.sap # Visual Studio Trace Files *.e2e # TFS 2012 Local Workspace $tf/ # Guidance Automation Toolkit *.gpState # ReSharper is a .NET coding add-in _ReSharper*/ *.[Rr]e[Ss]harper *.DotSettings.user # TeamCity is a build add-in _TeamCity* # DotCover is a Code Coverage Tool *.dotCover # AxoCover is a Code Coverage Tool .axoCover/* !.axoCover/settings.json # Coverlet is a free, cross platform Code Coverage Tool coverage*.json coverage*.xml coverage*.info # Visual Studio code coverage results *.coverage *.coveragexml # NCrunch _NCrunch_* .*crunch*.local.xml nCrunchTemp_* # MightyMoose *.mm.* AutoTest.Net/ # Web workbench (sass) .sass-cache/ # Installshield output folder [Ee]xpress/ # DocProject is a documentation generator add-in DocProject/buildhelp/ DocProject/Help/*.HxT DocProject/Help/*.HxC DocProject/Help/*.hhc DocProject/Help/*.hhk DocProject/Help/*.hhp DocProject/Help/Html2 DocProject/Help/html # Click-Once directory publish/ # Publish Web Output *.[Pp]ublish.xml *.azurePubxml # Note: Comment the next line if you want to checkin your web deploy settings, # but database connection strings (with potential passwords) will be unencrypted *.pubxml *.publishproj # Microsoft Azure Web App publish settings. Comment the next line if you want to # checkin your Azure Web App publish settings, but sensitive information contained # in these scripts will be unencrypted PublishScripts/ # NuGet Packages *.nupkg # NuGet Symbol Packages *.snupkg # The packages folder can be ignored because of Package Restore **/[Pp]ackages/* # except build/, which is used as an MSBuild target. !**/[Pp]ackages/build/ # Uncomment if necessary however generally it will be regenerated when needed #!**/[Pp]ackages/repositories.config # NuGet v3's project.json files produces more ignorable files *.nuget.props *.nuget.targets # Nuget personal access tokens and Credentials nuget.config # Microsoft Azure Build Output csx/ *.build.csdef # Microsoft Azure Emulator ecf/ rcf/ # Windows Store app package directories and files AppPackages/ BundleArtifacts/ Package.StoreAssociation.xml _pkginfo.txt *.appx *.appxbundle *.appxupload # Visual Studio cache files # files ending in .cache can be ignored *.[Cc]ache # but keep track of directories ending in .cache !?*.[Cc]ache/ # Others ClientBin/ ~$* *~ *.dbmdl *.dbproj.schemaview *.jfm *.pfx *.publishsettings orleans.codegen.cs # Including strong name files can present a security risk # (https://github.com/github/gitignore/pull/2483#issue-259490424) #*.snk # Since there are multiple workflows, uncomment next line to ignore bower_components # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) #bower_components/ # RIA/Silverlight projects Generated_Code/ # Backup & report files from converting an old project file # to a newer Visual Studio version. Backup files are not needed, # because we have git ;-) _UpgradeReport_Files/ Backup*/ UpgradeLog*.XML UpgradeLog*.htm ServiceFabricBackup/ *.rptproj.bak # SQL Server files *.mdf *.ldf *.ndf # Business Intelligence projects *.rdl.data *.bim.layout *.bim_*.settings *.rptproj.rsuser *- [Bb]ackup.rdl *- [Bb]ackup ([0-9]).rdl *- [Bb]ackup ([0-9][0-9]).rdl # Microsoft Fakes FakesAssemblies/ # GhostDoc plugin setting file *.GhostDoc.xml # Node.js Tools for Visual Studio .ntvs_analysis.dat node_modules/ # Visual Studio 6 build log *.plg # Visual Studio 6 workspace options file *.opt # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) *.vbw # Visual Studio LightSwitch build output **/*.HTMLClient/GeneratedArtifacts **/*.DesktopClient/GeneratedArtifacts **/*.DesktopClient/ModelManifest.xml **/*.Server/GeneratedArtifacts **/*.Server/ModelManifest.xml _Pvt_Extensions # Paket dependency manager .paket/paket.exe paket-files/ # FAKE - F# Make .fake/ # CodeRush personal settings .cr/personal # Python Tools for Visual Studio (PTVS) __pycache__/ *.pyc # Cake - Uncomment if you are using it # tools/** # !tools/packages.config # Tabs Studio *.tss # Telerik's JustMock configuration file *.jmconfig # BizTalk build output *.btp.cs *.btm.cs *.odx.cs *.xsd.cs # OpenCover UI analysis results OpenCover/ # Azure Stream Analytics local run output ASALocalRun/ # MSBuild Binary and Structured Log *.binlog # NVidia Nsight GPU debugger configuration file *.nvuser # MFractors (Xamarin productivity tool) working folder .mfractor/ # Local History for Visual Studio .localhistory/ # BeatPulse healthcheck temp database healthchecksdb # Backup folder for Package Reference Convert tool in Visual Studio 2017 MigrationBackup/ # Ionide (cross platform F# VS Code tools) working folder .ionide/ # Fody - auto-generated XML schema FodyWeavers.xsd # VS Code files for those working on multiple tools .vscode/* !.vscode/settings.json !.vscode/tasks.json !.vscode/launch.json !.vscode/extensions.json *.code-workspace # Local History for Visual Studio Code .history/ # Windows Installer files from build outputs *.cab *.msi *.msix *.msm *.msp # JetBrains Rider .idea/ *.sln.iml # Local files that should not be uploaded cmake.config CMakeSettings.json /CMakeUserPresets.json intel-igsc-7b83853/.gitlint000066400000000000000000000076141520747426000155270ustar00rootroot00000000000000# Edit this file as you like. # # All these sections are optional. Each section with the exception of [general] represents # one rule and each key in it is an option for that specific rule. # # Rules and sections can be referenced by their full name or by id. For example # section "[body-max-line-length]" could be written as "[B1]". Full section names are # used in here for clarity. # [general] # Ignore certain rules, this example uses both full name and id # ignore=title-trailing-punctuation, T3 # verbosity should be a value between 1 and 3, the commandline -v flags take precedence over this # verbosity = 2 # By default gitlint will ignore merge, revert, fixup and squash commits. # ignore-merge-commits=true # ignore-revert-commits=true # ignore-fixup-commits=true # ignore-squash-commits=true # Ignore any data send to gitlint via stdin # ignore-stdin=true # Fetch additional meta-data from the local repository when manually passing a # commit message to gitlint via stdin or --commit-msg. Disabled by default. # staged=true # Enable debug mode (prints more output). Disabled by default. # debug=true # Enable community contributed rules # See http://jorisroovers.github.io/gitlint/contrib_rules for details # Set the extra-path where gitlint will search for user defined rules # See http://jorisroovers.github.io/gitlint/user_defined_rules for details extra-path=gitlint # This is an example of how to configure the "title-max-length" rule and # set the line-length it enforces to 80 [title-max-length] line-length=80 # [title-must-not-contain-word] # Comma-separated list of words that should not occur in the title. Matching is case # insensitive. It's fine if the keyword occurs as part of a larger word (so "WIPING" # will not cause a violation, but "WIP: my title" will. # words=wip [title-match-regex] # python like regex (https://docs.python.org/2/library/re.html) that the # commit-msg title must be matched to. # Note that the regex can contradict with other rules if not used correctly # (e.g. title-must-not-contain-word). regex=^igsc:.* [body-max-line-length] line-length=72 [body-min-line-count] min-line-count=1 # [body-min-length] # min-length=5 # [body-is-missing] # Whether to ignore this rule on merge commits (which typically only have a title) # default = True # ignore-merge-commits=false # [body-changed-file-mention] # List of files that need to be explicitly mentioned in the body when they are changed # This is useful for when developers often erroneously edit certain files or git submodules. # By specifying this rule, developers can only change the file when they explicitly reference # it in the commit message. # files=gitlint/rules.py,README.md [author-valid-email] # python like regex (https://docs.python.org/2/library/re.html) that the # commit author email address should be matched to # For example, use the following regex if you only want to allow email addresses from foo.com #regex=[^@]+@intel.com # [ignore-by-title] # Ignore certain rules for commits of which the title matches a regex # E.g. Match commit titles that start with "Release" # regex=^Release(.*) # Ignore certain rules, you can reference them by their id or by their full name # Use 'all' to ignore all rules # ignore=T1,body-min-length # [ignore-by-body] # Ignore certain rules for commits of which the body has a line that matches a regex # E.g. Match bodies that have a line that that contain "release" # regex=(.*)release(.*) # # Ignore certain rules, you can reference them by their id or by their full name # Use 'all' to ignore all rules # ignore=T1,body-min-length # This is a contrib rule - a community contributed rule. These are disabled by default. # You need to explicitly enable them one-by-one by adding them to the "contrib" option # under [general] section above. # [contrib-title-conventional-commits] # Specify allowed commit types. For details see: https://www.conventionalcommits.org/ # types = bugfix,user-story,epic intel-igsc-7b83853/CHANGELOG.md000066400000000000000000000534551520747426000156710ustar00rootroot00000000000000# IGSC FUL ## [v1.3.0] - 2026-06-01 ### Added 1. lib: add igsc_library_version API for runtime version query 2. test: add unit tests for library version ## [v1.2.0] - 2026-04-27 ### Added 1. add OEM serial number API 2. test: add CLI bad input tests for oem ## [v1.1.0] - 2026-03-15 ### Fixed 1. cli: use signed variable 2. cli: reject non-hex flags in late-binding ### Removed 1. cli: drop unneeded status print ### Added 1. enum: find device with separate bdf 2. enum: udev: detect more gfx classes 3. lib: add new late bind APIs 4. test: add new late bind tests 5. cli: add new late bind commands 6. test: add tests for new late bind cli commands ## [v1.0.2] - 2026-01-14 ### Fixed 1. CMake: Linux: overwrite FORTIFY_SOURCE from distribution ## [v1.0.1] - 2025-11-19 ### Fixed 1. lib: fix metee logs ## [v1.0.0] - 2025-09-21 ### Changed 1. align whitespacing 2. CMake: move Conan requirement out of preset 3. cli: Prefix the debugging with a more suitable name ### Removed 1. lib: drop duplicate perf checkpoint ### Fixed 1. lib: fix strings 2. doc: small assorted fixes 3. lib: fix structures definition coding style 4. doc: fix igsc documentation 5. doc: fix numbering in igsc_api.rst ### Added 1. cli: retrieve firmware version before oprom and fw data update 2. cli: add oprom devid enforcement explanations 3. lib: add comment describing oprom update logic 4. cli: add missed out of memory print 5. doc: Clarify that fwupd is not using the library ## [v0.9.6] - 2025-06-17 ### Changed 1. enum: optimize search in udev 2. gitlint: drop requirement for intel address ### Removed 1. CMake: drop Conan support ### Fixed 1. Windows: fix copyright string 2. CMake: consume four-part version 3. small README fixes 4. cmake: Don't hardcode LIBDIR for installed cmake files ### Added 1. README: add AI disclaimer ## [v0.9.5] - 2024-11-06 ### Fixed 1. enable traffic dump in trace mode only 2. doc: fix doxygen generation 3. fix API documentation in header file ## [v0.9.4] - 2024-09-19 ### Added 1. lib: add timestamps to logs 2. cli: implement read firmware status register in cli 3. lib: implement read firmware status register library API 4. cli: print error message when device iterator failed ### Changed 1. lib: don't suppress metee error messages in debug mode ### Fixed 1. lib: fix device enumeration in linux ## [v0.9.3] - 2024-07-23 ### Fixed 1. conan: fix typo in conan.cmake 2. lib: fix typos in the library 3. doc: fix typos in api documentation 4. ci: fix-up codespell configuration 5. ut: check for null before strlen in test_strdup 6. lib: fix igsc_get_log_callback_func prototype ### Added 1. lib: add soc4 hardware sku ## [v0.9.2] - 2024-07-15 ### Fixed 1. lib: fix parameter check in igsc_gfsp_heci_cmd ## [v0.9.1] - 2024-07-11 ### Added 1. cli: add a retry on igsc_device_fwdata_version2 ### Fixed 1. ut: fix gfsc heci generic command test 2. lib: fix response size check 3. cli: fix possible memory leak in fwupd_strerror ### Changed 1. lib: expand firmware update errors handling ## [v0.9.0] - 2024-06-20 ### Added 1. lib: adding support to print IGSC debug logs via callback function 2. lib: add dedicated arb svn support 3. cli: add dedicated arb svn support 4. tests: add dedicated arb svn support ### Fixed 1. lib: drop version check from igsc_device_fwdata_update 2. cli: fix fw data update check ## [v0.8.21] - 2024-05-26 ### Changed 1. lib: pop the metee library version to 4.1.0 in conan 2. lib: set verbose metee mode ## [v0.8.20] - 2024-05-22 ### Fixed 1. lib: ignore return value of write on fwu_end command ## [v0.8.19] - 2024-05-17 ### Added 1. cli: implement retry mechanism when device is busy 2. lib: return busy indication on special connect failures ### Fixed 1. lib: fix fwdata heci response struct ### Removed 1. Doxygen: drop HTML timestamp ## [v0.8.18] - 2024-02-20 ### Added 1. doc: add documentation for arb svn library api 2. ut: add tests for arb svn API 3. cli: implement arb svn commands in cli 4. lib: implement arb svn library API ### Fixed 1. cli: fix description of the device in oem version command 2. doc: fix doc generation errors and warnings 3. CHANGELOG: fix item numbering ## [v0.8.17] - 2024-01-03 ### Added 1. docs: add igsc_device_update_late_binding_config 2. ut: add test for igsc_device_update_late_binding_config 3. cli: add late-binding command line option 4. lib: implement igsc_device_update_late_binding_config api 5. lib: add general gfsp heci command api 6. cli: add gfsp generic command to cli 7. ut: add tests for general gfsp heci cmd library api 8. doc: add generic gfsp heci message api documentation 9. README: add testing compilation explanation ### Fixed 1. lib: make OEM version an array of uint_8 instead of char 2. ut: fix handle initialization ### Changed 1. cli: print firmware status as hex form ## [v0.8.16] - 2023-10-31 ### Added 1. cli: add delay between the update and get firmware version ## [v0.8.15] - 2023-10-24 ### Changed 1. conan: use metee 3.2.4 ### Fixed 1. lib: wait for reset at the end of the update 2. lib: wait for background operation to finish ## [v0.8.14] - 2023-09-20 ### Fixed 1. gitignore: ignore VisualStudio directory 2. ci: fix clang-tidy reporting ### Changed 1. cli: do not use relative includes 2. cli: the global variables used only in one c file should be static 3. lib: move chunk_size declaration to its scope in gsc_update 4. ut: update cmake for new cmocka packaging ### Added 1. qb: copy PDB file to output and generate public pdb 2. Windows: generate pdb in Release build ## [v0.8.13] - 2023-06-13 ### Fixed 1. lib: disconnect on failure in gsc_driver_init ### Changed 1. lib: suppress specific errors during firmware reset 2. lib: quiet libmei errors around firmware reset flow 3. conan: use metee 3.2.3 ## [v0.8.11] - 2023-04-30 ### Added 1. build: sign dll 2. lib: add trace log level 3. lib: implement log levels 4. cli: set library log level in verbose mode 5. cli: add trace mode to cli ### Changed 1. lib: expand windows logs 2. lib: move received and sent data prints from debug to trace ### Fixed 1. lib: fix debug messages that should have been printed as errors 2. lib: fix printf format specifiers ### Removed 1. lib: remove check for version in get_hw_config 2. ut: remove get version from hw_config tests 3. cli: don't check hw_config when firmware does not support it 4. cli: remove unnecessary did enforcement check 5. lib: drop ifdef DEBUG around log prints ## [v0.8.9] - 2023-02-12 ### Changed 1. power: udev: demote error print in power/control open failure ### Fixed 1. ut: fix struct initializations for msvc 2. ut: igsc_test: no need to alloc handle for ctx 3. ut: fix the igsc_test to check for the correct return value 4. lib: check parameters of library api functions 5. lib: image_oprom_parse_cpd: prevent widening integer overflow 6. cli: do_firmware_update: remove unnecessary continue statement 7. lib: image_oprom_get_buffer check the assigned values 8. lib: check return value of gsc_image_fw_version function 9. lib: gsc_fwu_is_in_progress: don't assign unused value 10. cli: remove assignments of values that are logically unused 11. lib: initialize scalar variables ## [v0.8.8] - 2023-02-14 ### Added 1. lib: add timeout for oprom update to finish 3. tests: add firmware update unit test ### Changed 1. lib: reduce frequency of calling progress function ### Fixed 1. lib: sleep unconditionally during firmware updates cycles 2. lib: check the reserved fields of fwu response messages header 3. tests: initialize firmware version before retrieving it ## [v0.8.7] - 2023-01-09 ### Added 1. lib: add retries on initialization 2. tests: add test for retries in init ### Changed 1. conan: use MeTee 3.1.5 ### Fixed 1. README: fix documentation link to igsc_api.rst 2. README: add explanation how to run windows build 3. README: expand metee download explanations ## [v0.8.6] - 2022-12-20 ### Added 1. lib: add timeout for update to finish 2. lib: ifr: implement get health indicator api 3. doc: add documentation for get memory health indicator api 4. ut: add unit tests for health indicator api 5. cli: implement get memory health indicator in cli 6. lib: ifr: define get memory error mitigation status heci messages ### Fixed 1. cli: fix description in usage help ## [v0.8.5] - 2022-09-06 ### Added 1. doc: add documentation of oem, ifr and psc versions retrieval 2. ut: add tests for oem, ifr and psc version api 3. cli: implement retrieve ifr version in cli 4. cli: implement retrieve psc version in cli 5. lib: retrieve oem and psc binary versions 6. lib: define mkhi get version heci messages 7. cli: implement retrieval of oem version 8. lib: implement retrieval of oem version 9. lib: define oem, psc and ifr version api 10. lib: implement read file functionality 11. lib: define read file heci commands 12. lib: move mkhi header definition from ifr.h to igsc_heci.h 13. cli: retrieve firmware version before oprom and fw data update ### Fixed 1. lib: fix firmware data version retrieval 2. ci: fix docker user id for lms-ubuntu:19.10 3. lib: fix fw data heci version response handling ## [v0.8.4] - 2022-07-03 ### Added 1. README: mention libudev dependency 2. qb: add linux build script 3. ci: add quckbuild windows build script 4. cmake: add windows presets 5. cmake: add option to download dependencies from conan 6. cmake: enhance metee search 7. add error messages prints for unsupported hw config 8. src: add check of the versions after update 9. lib: add check of the versions after update 10. ci: enable tests compile 11. ci: print docker name also for cmake 12. ci: add ctest to compilation tasks 13. lib: add UNUSED_VAR cross platform macro ### Fixed 1. fix device ids extension number 2. conan: clean conanfile 3. cli: fix a memory leak in do_ifr_get_repair_info 4. lib: fix compilation warnings of ISO C90 5. lib: fix unsigned formats in print statements 6. cli: make fw and fw data versions prints more readable 7. tests: cmake: fix dependencies 8. ut: power_stubs.h fix includes 9. cmake: metee: the find package has to match the case 10. ci: move to self-hosted runners to other resource 11. ci: rename job clang-compile to compile ### Removed 1. lib: remove enable_enum option in cmake and meson ## [v0.8.3] - 2022-05-10 ### Added 1. lib: enum: windows: add domain (segment) retrieval ### Fixed 1. lib: enum: windows: fix device bdf retrieval ## [v0.8.2] - 2022-04-18 ### Added 1. lib: set power control to on during operations ## [v0.8.1] - 2022-03-22 ### Changed 1. conan: clean conanfile 2. lib: remove enable_enum option in cmake and meson 3. lib: extend igsc_hw_config_to_string ### Fixed 1. cli: fix return value treatment of match device function 2. lib: fix get device config function 3. lib: fix fw data heci version response handling 4. cli: fix a memory leak in do_ifr_get_repair_info 5. lib: fix compilation warnings of ISO C90 6. ut: power_stubs.h fix includes 7. tests: cmake: fix dependencies 8. lib: fix unsigned formats in print statements 9. cli: make fw and fw data versions prints more readable 10. lib: enum: windows: fix device bdf retrieval 11. cli: fix handling of match function return value 12. ut: fix image type in the test setup 13. lib: fix structures definition coding style 14. lib: fix gfsp_heci_validate_response_header usage 15. lib: fix error message in gfsp response validation 16. lib: gsc_fwu_get_version() initialize received_len 17. ut: fix uninitialized oprom_image structure in tests ### Added 1. src: add check of the versions after update 2. lib: add check of the versions after update 3. README: mention libudev dependency 4. lib: add UNUSED_VAR cross platform macro 5. cli: add error messages prints for unsupported hw config 6. lib: add error messages prints for unsupported hw config 7. lib: set power control to on during operations 8. lib: add debug prints for 4ids extension processing 9. lib: implement special case for images with no device extensions 10. cli: add oprom code update devId enforcement check 11. lib: add igsc_image_oprom_code_devid_enforced() 12. ut: add cli unit-tests for supported-devices 13. ut: add tests for the 4ids library functions 14. cli: implement supported-devices flag for oprom images 15. lib: add oprom image has 4ids or 2ids extension API 16. lib: add oprom image 4ids and 2ids extension query functions 17. lib: implement oprom 4ids library api 18. lib: implement oprom 4ids parsing helper functions 19. lib: parse 4ids supported device list extension 20. lib: use legacy device extension for oprom data only 21. lib: define 4-ids extension structures 22. lib: update the oprom code devId enforcement flag 23. lib: add oprom code device ids flag to heci reply 24. lib: add definitions of the new apis for 4-IDs oprom 25. lib: define the oprom device info structure with 4 IDs 26. cli: print status from fw in non-verbose mode 27. README: recommend visual studio 2019 28. cmake: add option to static build 29. cli: add ecc config commands 30. lib: implement ecc config commands 31. lib: add heci definitions for ecc config commands ## [v0.8.0] - 2022-07-10 Note: non backward compatible change (num_of_tiles to max_num_of_tiles) ### Changed 1. cli: rename num_of_tiles to max_num_of_tiles 2. lib: rename num_of_tiles to max_num_of_tiles 3. cli: report error on extra argument 4. lib: update ifr bitmaps definitions ### Fixed 1. cli: make print_mem_ppr_status output readable 2. cli: make mem_ppr_test output readable 3. cli: make get_status_ext output readable 4. cli: ifr: make array_scan_test output readable 5. lib: fix return value doc of the igsc_device_iterator_destroy 6. lib: ifr: rewords error messages and drop redundant debug 7. cli: remove redundant calls to get subsystem DID/VID 8. cli: remove redundant print from run_ifr_test 9. ut: initialize buffer in test function ### Added 1. cli: add missing newline in get_mem_ppr_status 2. doc: add info about multithreading support 3. doc: add documentation of get ifr repair info and count tiles APIs 4. ut: add tests for ifr get repair info and count tiles commands 5. cli: add ifr get repair info and count tiles commands to cli 6. lib: add ifr get tile repair info and count tiles library APIs 7. lib: add heci definitions for get ifr info commands 8. lib: update ifr bitmaps definitions 9. .gitignore: add cpack intermediate files 10. docs: .gitignore: add auto generated Doxygen ## [v0.7.0] - 2022-07-01 ### Added 1. ci: add codespell configuration files 2. doc: add documentation for the new ifr api 3. ut: ifr: add unit tests for the new ifr get status command 4. ut: ifr: add unit tests for ifr memory ppr test command 5. ut: ifr: add unit tests for ifr array&scan command 6. cli: add new ifr get status command to cli 7. cli: add ifr memory ppr command to cli 8. cli: add ifr array&scan command to cli 9. cli: extend struct gsc_op to include up to 5 subcommands 10. lib: implement new ifr get status api 11. lib: implement ifr memory ppr test command 12. lib: implement new ifr array&scan test command api 13. lib: ifr: define api to new ifr get status command 14. lib: ifr: define api to ifr array&scan and memory ppr tests 15. lib: ifr: define new ifr heci commands 16. ut: add unit tests for "get memory ppr status" 17. ut: add unit tests for "get number of memory errors" 18. doc: add documentation of "get number of memory errors" api 19. doc: add documentation for "get memory ppr status" api 20. cli: gfsp: implement get memory ppr status cli command 21. lib: gfsp: implement get memory ppr status api 22. lib: gfsp: add get memory PPR status heci message definitions 23. lib: gfsp: define "get memory PPR status" api 24. cli: gfsp: add get number of memory errors cli command 25. lib: gfsp: define get number of memory errors API 26. cmake: add windows presets 27. cmake: add option to download dependencies from conan ### Fixed 1. cli: fix ifr run-test command with --device parameter 2. lib: increase read timeout 3. lib: ifr: remove redundant include from ifr.h 4. lib: include msvc config.h in enum files 5. lib: adjust sku tag naming 6. ut: oprom update on bad type return invalid param error 7. lib: ifr: remove redundant include from ifr.h ### Changed 1. ut: remove obsolete definition of read_ifr_file 2. cmake: enhance metee search ## [v0.6.0] - 2022-02-20 ### Added 1. doc: add documentation of the get subsystem ids functionality 2. tests: add unit-test for subsystems ids functions 3. cli: add device info update 4. lib: implement get subsystem ids library function 5. lib: add get subsystem ids heci messages definitions 6. doc: add documentation for iaf psc partition update api 7. doc: add firmware data update api documentation ### Fixed 1. lib: fix wrong handling of return values in subsystem ids 2. lib: release fwdata image in igsc_device_fwdata_update() 3. lib: add more meaningful comments for enum gsc_fwu_heci_command_id 4. doc: fix library documentation of return values 5. doc: separate the ifr into higher level section 6. doc: little fixes in igsc_api ## [v0.5.0] - 2022-02-01 ### Added 1. tests: add fw data update tests 2. tests: add force update library function tests 3. cli: add force update option to fw update 4. lib: add force update bit flag to the lib 5. cli: add fw data update to cli 6. lib: add signed in field data update to the library 7. lib: add library API for the GSC In-Field Data Update 8. lib: support the second firmware reset in CP mode ### Fixed 1. tests: fix layout_parse function in firmware parser tests 2. lib: fix typos in comments in igsc_lib.h 3. lib: fix hw config comparison in library ## [v0.4.0] - 2022-01-30 ### Added 1. lib: send no update message at the end of firmware update 2. lib: retrieve hw configuration from the device 3. lib: add igsc_fw_hw_config_compatible() function 4. cli: add hw config option to cli ### Fixed 1. Fix VERSION file ## [V0.3.0] - 2022-01-17 ### Added 1. Add accelrator fabric PSC update 2. In field repair command support 3. Fix spelling of word 'firmware' ## [v0.2.6] - 2021-09-02 ### Fixed cli: print device BDF as a hexadecimal numbers lib: udev: parse device BDF as hexadecimal doc: fix igsc documentation ## [v0.2.5] - 2021-08-30 ### Added 1. scripts: add vscode build script ### Fixed 1. lib: check integer overflow in oprom parser 2. lib: try reconnect in a loop after firmware reset 3. lib: fix the gsc_msleep function 4. cli: fix debug print of sent data hex dump ## [v0.2.4] - 2021-06-14 ### Added 1. cmake: add package config helper ### Fixed 1. cli: fix oprom update error handling 2. lib: fix error value for mismatch of oprom image type and request ## [v0.2.3] - 2021-06-06 ### Added 1. lib: use generic BIT macro ### Fixed 1. oprom: fix type size comparison issue in oprom_parser.c 2. cli: add a message when permission denied 3. lib: add permission denied error code to the library 4. lib: restart firmware update in case of an error 5. lib: add timeout teewrite and teewrite 6. cli: prefix the firmware version in print 7. lib: CMake: require UDev library and header on Linux 8. CMake: set DEBUG defines in Debug mode 9. cli: oprom: fix print if good devid is not found in the image 11. oprom: use %d for uint32_t in debug prints ## [v0.2.2] - 2021-03-21 ### Added 1. doc: add no_update flow to the documentation 2. lib: send no update message at the end of firmware update 3. lib: generalize image update flow 4. lib: export tee handlers functions to the internal header ### Fixed ## [v0.2.1] - 2020-12-22 ### Added 1. lib: add igsc_internal.h with struct igsc_lib_ctx 2. doc: add firmware status code retrieval functions 3. cli: add firmware status print in verbose mode 4. lib: add return code from the firmware HECI messages 5. lib: add heci buffer trace (in debug code) 6. Add Apache 2 license file ### Fixed 1. metee.wrap use https instead of ssh for metee 2. cmake: drop REQUIRED for metee find_library 3. merge igsc_export.h into igsc_lib.h 4. README.md use uniform name for build directory 5. Add missing stack protection compilation flags 6. test: fix pointer sign conversion 7. Fix uninitialized variable warning in oprom_parser # IGSC FUL ## [v0.2.0] - 2020-10-08 ### Added 1. get image type API ### Fixed 1. Fixed few spelling errors ## [v0.1.4] - 2020-09-21 ### Added 1. Add requirements and tests ### Fixed 1. cmake: add security compilation flags ### Changed 1. lib: make enumeration part of the library optional 2. build: make cli binary build to be optional 3. build: remove dependency on cmake in meson ## [v0.1.3] - 2020-08-31 ### Added ### Fixed 1. cli: add more error messages 2. oprom: allow update when device version's major is 0 ### Changed ## [v0.1.2] - 2020-08-24 ### Added ### Fixed 1. cli: check for NULL returned from calloc() ### Changed ## [v0.1.1] - 2020-08-20 ### Added ### Fixed 1. cli: fix segmentation fault in firmware update with broken image 2. cli: change progress bar in oprom to display percentage only ### Changed 1. Unit tests improvements. 2. Simplify token matching in cli ## [v0.1.0] - 2020-08-16 ### Added 1. cli: Add progress function with percentage only 2. cli: Add --quiet option. 3. cli: Add more error messages. 4. cli: list devices supported by the OPROM image data 5. lib: Add firmware version comparison. 6. lib: Add oprom version comparison 7. lib: Retrieve BDF of the device 6. lib: Update udev matching to new driver API. ### Fixed 1. cli: print usage if there is no command after -q or -v option 3. cli: fix a progress bar issue 2. README: specify debug and release configurations ### Changed 1. Unit tests improvements. 2. Simplify token matching in cli ## [v0.0.9] - 2020-07-15 Enable update from a combined OPROM image ### Added 1. Added possibility to update OPROM from a combined image. 2. Verify OPROM data partition is supported by the device via subsystem vendor and device id 3. Implement igsc_device_init_by_handle() 4. Implement igsc_device_get_device_info() ### Fixed 1. Fix progress bar ### Changed 1. Remove enums from the API 2. UT cleanups ## [v0.0.8] - 2020-07-06 First internal release. ### Added 1. OPROM update API 2. Updated documentation ### Fixed 1. Linux: Reconnect after update. ### Changed intel-igsc-7b83853/CMakeLists.txt000066400000000000000000000065561520747426000166200ustar00rootroot00000000000000# SPDX-License-Identifier: Apache-2.0 # Copyright (C) 2019-2026 Intel Corporation cmake_minimum_required(VERSION 3.10) project(igsc C) set(LICENSE Apache) list(APPEND CMAKE_MODULE_PATH "${CMAKE_BINARY_DIR}") list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake") list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/Modules") include(version.cmake) add_definitions(-DIGSC_VERSION=\"${GSC_VERSION_STRING}\") include(GNUInstallDirs) if(NOT WIN32) option(SYSLOG "Use syslog for logging" ON) endif() option(ENABLE_PERF "Enable performance counters" OFF) option(ENABLE_DOCS "Enable docs build" OFF) option(ENABLE_TESTS "Perform unit tests after build" OFF) option(ENABLE_WERROR "Enable treat warnings as error" ON) option(ENABLE_CLI "Enable command line tool build" ON) option(ENABLE_TEST_GENERIC_GFSP_API "Enable test generic GFSP API" ON) option(BUILD_SHARED_LIBS "Build shared library" ON) include(CMakeDependentOption) cmake_dependent_option(TESTS_ENABLED "Perform unit tests after build" ON "ENABLE_CLI;ENABLE_TESTS" OFF) include(metee.cmake) set(COMPILE_OPTIONS_NX -Wall -Wextra -Wsign-compare -Wformat-security -Wstack-protector -Winit-self -Wstrict-prototypes -Wconversion -Woverflow -fwrapv -fPIC -fstack-protector-strong "$<$:-DDEBUG;-D_DEBUG>" "$<$:-O0;-g3;-ggdb>" "$<$:-O2;-U_FORTIFY_SOURCE;-D_FORTIFY_SOURCE=2>" "$<$:-Werror>" ) set(COMPILE_OPTIONS_GCC -fno-strict-overflow -fno-delete-null-pointer-checks ) set(COMPILE_OPTIONS_WIN /DUNICODE /D_UNICODE /W4 /MT$<$:d> /GS /sdl "$<$:/WX>" "$<$:/Zi>" ) set(CMAKE_POSITION_INDEPENDENT_CODE ON) set(LINK_OPTIONS_NX "-z noexecstack -z relro -z now") set(LINK_EXE_OPTIONS_NX "-pie") set(LINK_OPTIONS_WIN "/NXCompat /DynamicBase /GUARD:CF /INCREMENTAL:NO /DEBUG:FULL /OPT:REF /OPT:ICF") if(CMAKE_C_COMPILER_ID MATCHES Clang OR CMAKE_C_COMPILER_ID MATCHES AppleClang) set(COMPILE_OPTIONS ${COMPILE_OPTIONS_NX}) set(LINK_OPTIONS ${LINK_OPTIONS_NX}) set(LINX_EXE_OPTIONS ${LINK_EXE_OPTIONS_NX}) elseif(CMAKE_C_COMPILER_ID MATCHES GNU) set(COMPILE_OPTIONS ${COMPILE_OPTIONS_NX} ${COMPILE_OPTIONS_GCC}) set(LINK_OPTIONS ${LINK_OPTIONS_NX}) set(LINX_EXE_OPTIONS ${LINK_EXE_OPTIONS_NX}) elseif(CMAKE_C_COMPILER_ID MATCHES MSVC) set(COMPILE_OPTIONS ${COMPILE_OPTIONS_WIN}) set(LINK_OPTIONS ${LINK_OPTIONS_WIN}) endif() set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${LINK_OPTIONS} ${LINX_EXE_OPTIONS}") set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} ${LINK_OPTIONS}") add_subdirectory("lib") if(ENABLE_CLI) add_subdirectory("src") endif() if(TESTS_ENABLED) add_subdirectory("tests") endif() if(ENABLE_DOCS) add_subdirectory("doc") endif() include(dist.cmake) set(CPACK_PACKAGE_NAME ${PROJECT_NAME}) if(WIN32 AND NOT UNIX) set(CPACK_GENERATOR "ZIP") else() set(CPACK_GENERATOR "TGZ") endif() set(CPACK_PACKAGE_VERSION_MAJOR ${GSC_VERSION_MAJOR}) set(CPACK_PACKAGE_VERSION_MINOR ${GSC_VERSION_MINOR}) set(CPACK_PACKAGE_VERSION_PATCH ${GSC_VERSION_PATCH}) set(CPACK_PACKAGE_VENDOR "Intel, Inc") set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Graphics System Controller Firmware Update Library") set(CPACK_PACKAGE_DESCRIPTION_FILE ${PROJECT_SOURCE_DIR}/README.md) include(CPack) intel-igsc-7b83853/CMakePresets.json000066400000000000000000000021251520747426000172650ustar00rootroot00000000000000{ "version": 2, "configurePresets": [ { "name": "base", "displayName": "Windows x86-64 base", "description": "Build x86-64 Release, VS2019", "hidden": true, "generator": "Visual Studio 16 2019", "architecture": { "value": "x64", "strategy": "set" } }, { "name": "Debug", "displayName": "Windows x86-64 Debug", "description": "Build x86-64 Debug, VS2019", "inherits": "base", "binaryDir": "${sourceDir}/Debug", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug" } }, { "name": "Release", "displayName": "Windows x86-64 Release", "description": "Build x86-64 Release, VS2019", "inherits": "base", "binaryDir": "${sourceDir}/Release", "cacheVariables": { "CMAKE_BUILD_TYPE": "Release" } } ], "buildPresets": [ { "name": "Debug", "configurePreset": "Debug", "configuration": "Debug" }, { "name": "Release", "configurePreset": "Release", "configuration": "Release" } ] } intel-igsc-7b83853/LICENSE.txt000066400000000000000000000261361520747426000156770ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. intel-igsc-7b83853/README.md000066400000000000000000000051611520747426000153260ustar00rootroot00000000000000# Intel(R) Graphics System Controller Firmware Update Library (IGSC FUL) -------------------------------------------------------------------------- ## Introduction --------------- ### Documentation [API Documentation](doc/igsc_api.rst "API Documentation") ## Build ### Requirements: #### Cross-platform ##### MeTee If MeTee library is not found in the system paths CMake and Meson scripts downloads the MeTee library sources from [GitHub](https://github.com/intel/metee) (git installation and correct proxy setup are required). Alternatively, in order to use pre-compiled MeTee one can set the following environment variables: * METEE_LIB_PATH to pre-compiled library path * METEE_HEADER_PATH to headers path #### Linux * libudev (libudev-dev package in Debian) Both CMake and meson build framework are supported. ### CMake **Example:** *Linux:* ```sh cmake -G Ninja -S . -B builddir ninja -v -C builddir ``` *Linux Debug version:* ```sh cmake -DSYSLOG:BOOL=OFF -DCMAKE_BUILD_TYPE=Debug -G Ninja -S . -B builddir ninja -v -C builddir ``` *Linux Debug with tests:* ```sh cmake -DSYSLOG:BOOL=OFF -DENABLE_TESTS:BOOL=ON -DCMAKE_BUILD_TYPE=Debug -G Ninja -S . -B builddir ninja -v -C builddir ``` *Windows: (Visual Studio 2019)* From the "Developer Command Prompt for VS 2019" with CMake component installed: ```sh cmake -G "Visual Studio 16 2019" -S . -B builddir cmake --build builddir --config Release ``` *Windows Debug version: (Visual Studio 2019)* From the "Developer Command Prompt for VS 2019" with CMake component installed: ```sh cmake -G "Visual Studio 16 2019" -S . -B builddir cmake --build builddir --config Debug ``` ### meson **Example:** ```sh meson setup builddir/ meson configure -Dsyslog=true builddir ninja -v -C builddir/ ``` ## Command Line Tool Usage Example: -------------------------- `# igsc update|version [--image ] [ --device ]` **Example:** `# igsc fw version --device /dev/mei2 `# igsc oprom-data update --image ` ## Library and CLI Version The library is versioned according [semantic versioning 2.0.0](https://semver.org/ "semantic versioning") *MAJOR.MINOR.PATCH-, incrementing the: * *MAJOR* incompatible API changes, * *MINOR* add functionality in a backwards compatible manner * *PATCH* version when you make backwards compatible bug fixes. * *Extension Label* git shortened commit hash or other extension. ## Artificial Intelligence These contents may have been developed with support from one or more Intel-operated generative artificial intelligence solutions. intel-igsc-7b83853/SECURITY.md000066400000000000000000000010731520747426000156360ustar00rootroot00000000000000# Security Policy Intel is committed to rapidly addressing security vulnerabilities affecting our customers and providing clear guidance on the solution, impact, severity and mitigation. ## Supported Versions | Version | Supported | | --------- | ------------------ | | 0.8.10 | :white_check_mark: | | < 0.8.10 | :x: | ## Reporting a Vulnerability Please report any security vulnerabilities in this project [utilizing the guidelines here](https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html). intel-igsc-7b83853/VERSION000066400000000000000000000000061520747426000151100ustar00rootroot000000000000001.3.0 intel-igsc-7b83853/cmake/000077500000000000000000000000001520747426000151245ustar00rootroot00000000000000intel-igsc-7b83853/cmake/FindSphinx.cmake000066400000000000000000000017571520747426000202120ustar00rootroot00000000000000# SPDX-License-Identifier: NSCA # From llvm.org llvm/cmake/modules/ # CMake find_package() Module for Sphinx documentation generator # http://sphinx-doc.org/ # # Example usage: # # find_package(Sphinx) # # If successful the following variables will be defined # SPHINX_FOUND # SPHINX_EXECUTABLE find_program(SPHINX_EXECUTABLE NAMES sphinx-build sphinx-build2 DOC "Path to sphinx-build executable") # Handle REQUIRED and QUIET arguments # this will also set SPHINX_FOUND to true if SPHINX_EXECUTABLE exists include(FindPackageHandleStandardArgs) find_package_handle_standard_args(Sphinx "Failed to locate sphinx-build executable" SPHINX_EXECUTABLE) # Provide options for controlling different types of output option(SPHINX_OUTPUT_HTML "Output standalone HTML files" ON) option(SPHINX_OUTPUT_MAN "Output man pages" ON) option(SPHINX_WARNINGS_AS_ERRORS "When building documentation treat warnings as errors" ON) intel-igsc-7b83853/cmake/Findmetee.cmake000066400000000000000000000015441520747426000200320ustar00rootroot00000000000000# SPDX-License-Identifier: Apache-2.0 # Copyright (C) 2021-2022 Intel Corporation find_path(METEE_INCLUDE_DIR NAMES metee.h PATHS /usr/include ENV METEE_HEADER_PATH ) find_library(METEE_LIBRARY metee PATHS ENV METEE_LIB_PATH ) set(METEE_INCLUDE_DIRS ${METEE_INCLUDE_DIR}) set(METEE_LIBRARIES ${METEE_LIBRARY}) include(FindPackageHandleStandardArgs) FIND_PACKAGE_HANDLE_STANDARD_ARGS(metee FOUND_VAR METEE_FOUND REQUIRED_VARS METEE_LIBRARY METEE_INCLUDE_DIR) mark_as_advanced(METEE_INCLUDE_DIR METEE_LIBRARY) if(METEE_FOUND AND NOT TARGET metee::metee) add_library(metee::metee UNKNOWN IMPORTED) set_target_properties(metee::metee PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${METEE_INCLUDE_DIR}") set_property(TARGET metee::metee APPEND PROPERTY IMPORTED_LOCATION "${METEE_LIBRARY}") endif() intel-igsc-7b83853/cmake/Modules/000077500000000000000000000000001520747426000165345ustar00rootroot00000000000000intel-igsc-7b83853/cmake/Modules/AddCMockaTest.cmake000066400000000000000000000103251520747426000221450ustar00rootroot00000000000000# # Copyright (c) 2007 Daniel Gollub # Copyright (c) 2007-2018 Andreas Schneider # Copyright (c) 2018 Anderson Toshiyuki Sasaki # # Redistribution and use is allowed according to the terms of the BSD license. # For details see the accompanying COPYING-CMAKE-SCRIPTS file. #.rst: # AddCMockaTest # ------------- # # This file provides a function to add a test # # Functions provided # ------------------ # # :: # # add_cmocka_test(target_name # SOURCES src1 src2 ... srcN # [COMPILE_OPTIONS opt1 opt2 ... optN] # [LINK_LIBRARIES lib1 lib2 ... libN] # [LINK_OPTIONS lopt1 lop2 .. loptN] # ) # # ``target_name``: # Required, expects the name of the test which will be used to define a target # # ``SOURCES``: # Required, expects one or more source files names # # ``COMPILE_OPTIONS``: # Optional, expects one or more options to be passed to the compiler # # ``LINK_LIBRARIES``: # Optional, expects one or more libraries to be linked with the test # executable. # # ``LINK_OPTIONS``: # Optional, expects one or more options to be passed to the linker # # # Example: # # .. code-block:: cmake # # add_cmocka_test(my_test # SOURCES my_test.c other_source.c # COMPILE_OPTIONS -g -Wall # LINK_LIBRARIES mylib # LINK_OPTIONS -Wl,--enable-syscall-fixup # ) # # Where ``my_test`` is the name of the test, ``my_test.c`` and # ``other_source.c`` are sources for the binary, ``-g -Wall`` are compiler # options to be used, ``mylib`` is a target of a library to be linked, and # ``-Wl,--enable-syscall-fixup`` is an option passed to the linker. # enable_testing() include(CTest) if (CMAKE_CROSSCOMPILING) if (WIN32) find_program(WINE_EXECUTABLE NAMES wine) set(TARGET_SYSTEM_EMULATOR ${WINE_EXECUTABLE} CACHE INTERNAL "") endif() endif() function(ADD_CMOCKA_TEST _TARGET_NAME) set(one_value_arguments ) set(multi_value_arguments SOURCES COMPILE_OPTIONS LINK_LIBRARIES INCLUDE_DIRECTORIES LINK_OPTIONS ) cmake_parse_arguments(_add_cmocka_test "" "${one_value_arguments}" "${multi_value_arguments}" ${ARGN} ) if (NOT DEFINED _add_cmocka_test_SOURCES) message(FATAL_ERROR "No sources provided for target ${_TARGET_NAME}") endif() add_executable(${_TARGET_NAME} ${_add_cmocka_test_SOURCES}) if (DEFINED _add_cmocka_test_COMPILE_OPTIONS) target_compile_options(${_TARGET_NAME} PRIVATE ${_add_cmocka_test_COMPILE_OPTIONS} ) endif() if (DEFINED _add_cmocka_test_LINK_LIBRARIES) target_link_libraries(${_TARGET_NAME} PRIVATE ${_add_cmocka_test_LINK_LIBRARIES} ) endif() if (DEFINED _add_cmocka_test_INCLUDE_DIRECTORIES) target_include_directories(${_TARGET_NAME} PRIVATE ${_add_cmocka_test_INCLUDE_DIRECTORIES} ) endif() if (DEFINED _add_cmocka_test_LINK_OPTIONS) set_target_properties(${_TARGET_NAME} PROPERTIES LINK_FLAGS ${_add_cmocka_test_LINK_OPTIONS} ) endif() add_test(${_TARGET_NAME} ${TARGET_SYSTEM_EMULATOR} ${_TARGET_NAME} ) endfunction (ADD_CMOCKA_TEST) function(ADD_CMOCKA_TEST_ENVIRONMENT _TARGET_NAME) if (WIN32 OR CYGWIN OR MINGW OR MSVC) file(TO_NATIVE_PATH "${cmocka-library_BINARY_DIR}" CMOCKA_DLL_PATH) if (TARGET_SYSTEM_EMULATOR) set(DLL_PATH_ENV "WINEPATH=${CMOCKA_DLL_PATH};$ENV{WINEPATH}") else() set(DLL_PATH_ENV "PATH=${CMOCKA_DLL_PATH};$ENV{PATH}") endif() # # IMPORTANT NOTE: The set_tests_properties(), below, internally # stores its name/value pairs with a semicolon delimiter. # because of this we must protect the semicolons in the path # string(REPLACE ";" "\\;" DLL_PATH_ENV "${DLL_PATH_ENV}") set_tests_properties(${_TARGET_NAME} PROPERTIES ENVIRONMENT "${DLL_PATH_ENV}") endif() endfunction() intel-igsc-7b83853/dist.cmake000066400000000000000000000005671520747426000160210ustar00rootroot00000000000000# SPDX-License-Identifier: Apache-2.0 # Copyright (C) 2020 Intel Corporation # Source package set(ARCHIVE_NAME ${PROJECT_NAME}-${GSC_VERSION_STRING}) add_custom_target(dist COMMAND git archive --prefix=${ARCHIVE_NAME}/ HEAD | bzip2 > ${CMAKE_BINARY_DIR}/${ARCHIVE_NAME}.tar.bz2 WORKING_DIRECTORY ${CMAKE_SOURCE_DIR} COMMENT "Create the source package" ) intel-igsc-7b83853/doc/000077500000000000000000000000001520747426000146115ustar00rootroot00000000000000intel-igsc-7b83853/doc/.gitignore000066400000000000000000000001241520747426000165760ustar00rootroot00000000000000# Ignore everything in this directory _build/ Thumbs.db .DS_Store py-sphinx Doxygen intel-igsc-7b83853/doc/CMakeLists.txt000066400000000000000000000037061520747426000173570ustar00rootroot00000000000000# SPDX-License-Identifier: Apache-2.0 # Copyright (C) 2020-2024 Intel Corporation find_package(Doxygen REQUIRED) get_target_property(IGSC_PUBLIC_HEADER igsc PUBLIC_HEADER) set(DOXYGEN_INPUT ${IGSC_PUBLIC_HEADER}) set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen) set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/html/index.html) set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/doxyfile.in) set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY) file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR}) add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE} DEPENDS ${IGSC_PUBLIC_HEADER} COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} MAIN_DEPENDENCY ${DOXYFILE_IN} COMMENT "Generating docs") add_custom_target(Doxygen DEPENDS ${DOXYGEN_INDEX_FILE}) add_dependencies(igsc Doxygen) if(UNIX) install(DIRECTORY ${DOXYGEN_OUTPUT_DIR}/man/man3 DESTINATION ${CMAKE_INSTALL_MANDIR} ) install(DIRECTORY ${DOXYGEN_OUTPUT_DIR}/html DESTINATION ${CMAKE_INSTALL_DOCDIR} ) else() install(DIRECTORY ${DOXYGEN_OUTPUT_DIR}/html DESTINATION doc) endif() find_package(Sphinx REQUIRED) set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}) set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/sphinx) set(SPHINX_INDEX_FILE ${SPHINX_BUILD}/index.html) file(GLOB_RECURSE RST_FILES ${CMAKE_SOURCE_DIR}/*.rst) add_custom_command(OUTPUT ${SPHINX_INDEX_FILE} COMMAND ${SPHINX_EXECUTABLE} -b html -Dbreathe_projects.igsc=${DOXYGEN_OUTPUT_DIR}/xml ${SPHINX_SOURCE} ${SPHINX_BUILD} WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} DEPENDS ${RST_FILES} ${DOXYGEN_INDEX_FILE} MAIN_DEPENDENCY ${SPHINX_SOURCE}/conf.py COMMENT "Generating documentation with Sphinx") add_custom_target(Sphinx DEPENDS ${SPHINX_INDEX_FILE}) intel-igsc-7b83853/doc/Makefile000066400000000000000000000011571520747426000162550ustar00rootroot00000000000000# Minimal makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build SPHINXPROJ = GraphicsFirmwareInterface SOURCEDIR = . BUILDDIR = _build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) .PHONY: help Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) intel-igsc-7b83853/doc/README.md000066400000000000000000000007611520747426000160740ustar00rootroot00000000000000# IGSC FU Documentation ## Setup Linux Source the setup-env.sh directory to setup python virtual environment `$ source ./setup-env.sh` To leave the environment user python venv deactivate `$ deactivate` ## Compilation The docs are not created on default, to enable building docs from cmake set ENABLE_DOCS to ON `$cmake -DENABLE_DOCS:BOOL=ON` ## Standalone build For CI purposes there is a standalone version documentation creation using make. `$export STANDALONE_DOCS=1` `$make html` intel-igsc-7b83853/doc/_static/000077500000000000000000000000001520747426000162375ustar00rootroot00000000000000intel-igsc-7b83853/doc/_static/.gitignore000066400000000000000000000001071520747426000202250ustar00rootroot00000000000000# Ignore everything in this directory * # Except this file !.gitignore intel-igsc-7b83853/doc/_templates/000077500000000000000000000000001520747426000167465ustar00rootroot00000000000000intel-igsc-7b83853/doc/_templates/.gitignore000066400000000000000000000001071520747426000207340ustar00rootroot00000000000000# Ignore everything in this directory * # Except this file !.gitignore intel-igsc-7b83853/doc/cli.rst000066400000000000000000000067631520747426000161260ustar00rootroot000000000000003. Command Line Tool ---------------------- The library provides a sample command line tool that demonstrate usage of the library. 3.1 Usage: ~~~~~~~~~~ .. code-block:: sh igsc [-h] [-v] [options] *Supported partitions:* * *fwi* : GSC Firmware * *oprom-code* : code (GOP) OPROM partition * *oprom-data* : data (VBT) OPROM partition *Flags:* * -h | --help: displays usage and help for the tool * -V | --version: displays the CLI version and igsc library version * -v | --verbose: verbose mode 3.2 GSC Firmware Update ~~~~~~~~~~~~~~~~~~~~~~~~~~ 1. Update device with the specific firmware image, in case the device is not supplied the tool will use the first available device. * options --allow-downgrade .. code-block:: sh igsc fw update [optinons] --image [--device ] 2. Retrieve the firmware version on the device, in case the device is not supplied the tool will use the first available device. .. code-block:: sh igsc fw version [--device ] 3. Retrieve the firmware version in the supplied image file. .. code-block:: sh igsc fw version --image 4. Retrieve the hw configuration of the device, in case the device is not supplied the tool will use the first available device. .. code-block:: sh igsc fw hwconfig [--device ] 5. retrieve hw configuration supported by the supplied image file. .. code-block:: sh igsc fw hwconfig --image 6. Check for hw configuration compatibility between the device and by the supplied image file. .. code-block:: sh igsc fw hwconfig --check --image [--device ] 3.3 OPROM Update ~~~~~~~~~~~~~~~~~ 1. Update OPROM data (VBT) partition version, in case the device is not supplied the tool will use the first available device. * options --allow-downgrade .. code-block:: sh igsc oprom update [options] [--device ] --image 2. Retrieve OPROM VBT (data) partition version .. code-block:: sh igsc oprom-data version [--device ] 3. Retrieve OPROM VBT (data) partition version from the supplied data image file, .. code-block:: sh igsc oprom-data version --image 4. Update OPROM code partition version, in case the device is not supplied the tool will use first available device. * options --allow-downgrade .. code-block:: sh igsc oprom-code update [options] [--device ] --image 5. Retrieve list of supported devices from the supplied OPROM data image, in form of subvendor and subdevice pci list. .. code-block:: sh igsc oprom-code supported-devices --image 6. Retrieve OPROM code (GOP) partition version from the device, in case the device is not supplied the tool will use the first available device. .. code-block:: sh igsc oprom-code version [--device ] 7. Retrieve OPROM code partition version from the supplied data image file .. code-block:: sh igsc oprom-code version --image 3.4 Device enumeration ~~~~~~~~~~~~~~~~~~~~~~~ List all supported devices on the system. If --info flag is supplied also print the firmware and OPROM partitions versions on each device. .. code-block:: sh igsc list-devices [--info] 3.5 In-Field Repair ~~~~~~~~~~~~~~~~~~~~~ .. code-block:: sh igsc ifr get-status --device /dev/meiX .. code-block:: sh igsc ifr run-test --device /dev/meiX --tile [0|1|all] --test [scan|array] intel-igsc-7b83853/doc/conf.py000066400000000000000000000143051520747426000161130ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a # full list see the documentation: # http://www.sphinx-doc.org/en/master/config # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # import os # import sys # sys.path.insert(0, os.path.abspath('.')) # -- Project information ----------------------------------------------------- project = 'Graphics Firmware Interface' copyright = u'2020, Intel' author = 'Intel, Inc' standalone_docs = os.environ.get('STANDALONE_DOCS', None) if standalone_docs: IGSC_BASE = os.path.abspath('..') IGSC_BUILD = '_build' version = '0.5' with open(os.path.join(IGSC_BASE, 'VERSION')) as the_fd: version = the_fd.readline() # The short X.Y version # The full version, including alpha/beta/rc tags release = version # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'breathe', 'sphinx.ext.todo', 'sphinx.ext.imgmath', 'sphinx.ext.githubpages', 'sphinx.ext.imgconverter', 'sphinx_tabs.tabs' ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path . exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'py-sphinx'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] html_theme_options = { 'prev_next_buttons_location': None } # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # # html_theme_options = {} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # The default sidebars (for documents that don't match any pattern) are # defined by theme itself. Builtin themes are using these templates by # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. # # html_sidebars = {} # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = 'gscfudoc' # -- Options for LaTeX output ------------------------------------------------ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'GraphicsFirmwareInterface.tex', 'Graphics Firmware Interface Documentation', 'Intel', 'manual'), ] # -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'igsc', 'Graphics System Controller Firmware Interface Documentation', [author], 1) ] # -- Options for Texinfo output ---------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'GraphicsFirmwareInterface', 'Graphics Firmware Interface Documentation', author, 'GraphicsFirmwareInterface', 'One line description of project.', 'Miscellaneous'), ] # -- Extension configuration ------------------------------------------------- breathe_default_project = "igsc" def configure_doxyfile(input_dir, output_dir): with open('doxyfile.in', 'r') as in_fh: filedata = in_fh.read() filedata = filedata.replace('@DOXYGEN_INPUT_DIR@', input_dir) filedata = filedata.replace('@DOXYGEN_OUTPUT_DIR@', output_dir) with open('Doxyfile', 'w') as out_fh: out_fh.write(filedata) breathe_projects = { "igsc": "", } if standalone_docs: import subprocess input_dir = IGSC_BASE output_dir = IGSC_BUILD configure_doxyfile(input_dir, output_dir) subprocess.call('doxygen', shell=True) breathe_projects['igsc'] = os.path.join(output_dir, 'xml') # -- Options for todo extension ---------------------------------------------- # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True intel-igsc-7b83853/doc/copyright.rst000066400000000000000000000001531520747426000173520ustar00rootroot00000000000000:orphan: .. _doc-copyrights: Documentation Copyrights ######################## * 2020 Intel Corporation intel-igsc-7b83853/doc/doxyfile.in000066400000000000000000003176441520747426000170030ustar00rootroot00000000000000# SPDX-License-Identifier: Apache-2.0 # Copyright (C) 2020-2024 Intel Corporation # Doxyfile 1.8.11 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = "Intel Graphics System Controller Firmware Update Library" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "Intel Graphics System Controller Firmware Update Library" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIR@ # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = NO # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = YES # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = @DOXYGEN_INPUT@ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. FILE_PATTERNS = "*.h" # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the # cost of reduced performance. This can be particularly helpful with template # rich C++ code for which doxygen's built-in parser lacks the necessary type # information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse-libclang=ON option for CMake. # The default value is: NO. # CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. # CLANG_OPTIONS = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: http://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /