gpu_control_list_format.txt 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. // Copyright (c) 2013 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. // A valid gpu control list json file is in the format of
  5. // {
  6. // "version": "x.y",
  7. // "entries": [
  8. // { // entry 1
  9. // },
  10. // ...
  11. // { // entry n
  12. // }
  13. // ]
  14. // }
  15. //
  16. // Each entry contains the following fields (fields are optional unless
  17. // specifically described as mandatory below):
  18. // 1. "id" is an integer. 0 is reserved. This field is mandatory.
  19. // 2. "os" contains "type" and an optional "version". "type" could be "macosx",
  20. // "linux", "win", "chromeos", or "any". "any" is the same as not specifying
  21. // "os".
  22. // "version" is a VERSION structure (defined below).
  23. // 3. "vendor_id" is a string. 0 is reserved.
  24. // 4. "device_id" is an array of strings. 0 is reserved
  25. // 5. "device_revision" is an array of strings. Default is 0. This is Windows
  26. // only. There are three ways to specify a device on Windows:
  27. // a) only specify device IDs;
  28. // b) specify one device ID, associate with multiple revisions;
  29. // c) specify k device IDs, associate with k device revisions.
  30. // https://docs.microsoft.com/en-us/windows-hardware/drivers/install/identifiers-for-pci-devices
  31. // 6. "multi_gpu_style" is a string, valid values include:
  32. // a) "optimus": NVIDIA dual GPU
  33. // b) "amd_switchable": AMD dual GPU
  34. // c) "amd_switchable_integrated": AMD dual GPU, integrated GPU is active
  35. // d) "amd_switchable_discrete": AMD dual GPU, discrete GPU is active
  36. // c) and d) are only valid on Win, as on Mac we can switch GPU on the fly.
  37. // 7. "multi_gpu_category" is a string, valid values include "any", "primary",
  38. // "secondary", and "active". If unspecified, the default value is "active".
  39. // See gpu_control_list.h for more details on the meanings of the strings.
  40. // 8. "driver_vendor" is a string pattern. (Not available on Windows)
  41. // 9. "driver_version" is a VERSION structure (defined below). On Windows
  42. // this value can be retrieved by searching for the "Driver File Version" in
  43. // dxdiag.txt
  44. // 10. "gl_type" is a string, valid values include "gl", "gles", and "angle".
  45. // If "gl_version" is specified and "gl_type" is not, use the default value.
  46. // The default value on Android is "gles", on Windows is "angle", on other
  47. // platforms is "gl".
  48. // 11. "gl_version" is a VERSION structure (defined below).
  49. // 12. "gl_vendor" is a string pattern.
  50. // 13. "gl_renderer" is a string pattern.
  51. // 14. "gl_extensions" is a string pattern.
  52. // 15. "machine_model_name" is an array of string patterns.
  53. // 16. "machine_model_version" is a VERSION structure (defined below).
  54. // 17. "gpu_count" is a INT structure (defined below).
  55. // 18. "cpu_info" is a string pattern.
  56. // 19. "exceptions" is a list of entries.
  57. // 20. "features" is a list of gpu control list options, which can be
  58. // configured by a specific list. See its *_json.cc file for a list of
  59. // supported features. This field is mandatory.
  60. // An "exceptions" list to the features can be added for convenience instead
  61. // of listing all features except one.
  62. // 21. "description" has the description of the entry.
  63. // 22. "webkit_bugs" is an array of associated webkit bug numbers.
  64. // 23. "cr_bugs" is an array of associated webkit bug numbers.
  65. // 24. "disabled" is a boolean. If it is present, the entry will be skipped.
  66. // This can not be used in exceptions.
  67. // 25. "direct_rendering" is a boolean. If present, this will filter on whether
  68. // the GL contexts are direct or indirect based on the value.
  69. // 26. "disabled_extensions" is a list of strings which contain the GL_EXTENSION
  70. // strings which are disabled by the workaround.
  71. // 27. "pixel_shader_version" is a VERSION structure (defined below).
  72. // 28. "test_group" is an non-negative integer. If not specified, it defaults
  73. // to 0, which is Chrome's blocklist. Any entries with a non-zero test_group
  74. // ID will be appended on top of the default group entries if Chrome runs
  75. // with --gpu-blocklist-test-group=ID.
  76. // 29. "intel_gpu_series" is a list of gpu series names. Currently supported
  77. // series include: "broadwater", "eaglelake", "ironlake", "sandybridge",
  78. // "baytrail", "ivybridge", "haswell", "cherrytrail", "broadwell",
  79. // "apollolake", "skylake", "geminilake", "kabylake", "coffeelake",
  80. // "whiskeylake", "cometlake", "cannonlake", "icelake", "elkhartlake",
  81. // "jasperlake", "tigerlake", "alderlake".
  82. // 30. "hardware_overlay" is either "supported" or "unsupported". Currently it
  83. // only applies on Windows where hardware overlays may be supported on
  84. // certain Intel GPUs. By default it's "dont_care" and there is no need to
  85. // specify that.
  86. // 31. "intel_gpu_generation" is a VERSION structure. Each Intel GPU has a
  87. // specific integer (meaning generation) associated.
  88. // 32. "subpixel_font_rendering" is either "supported" or "unsupported".
  89. // Currently it only applies on ChromeOS where subpixel font rendering
  90. // causes a glitch on Mali GPUs. By default it's "dont_care" and there is
  91. // no need to specify that.
  92. // 33. "driver_update_link" provides a link where affected users with older
  93. // drivers can download a newer driver to avoid triggering this entry.
  94. // Such link will be displayed in chrome://gpu for affected devices.
  95. //
  96. // VERSION includes "op", "style", "schema", "value", and "value2". "op" can
  97. // be any of the following values: "=", "<", "<=", ">", ">=", "any", "between".
  98. // "style" is optional and can be "lexical" or "numerical"; if it's not
  99. // specified, it defaults to "numerical". "schema" is optional and can be
  100. // "common", "intel_driver" or "nvidia_driver"; if it's not specified, it
  101. // defaults to "common"; it's an error to specify "(intel|nvidia)_driver" schema
  102. // for entries that are not specifically for Intel|Nvidia GPUs on Windows.
  103. // "value2" is only used if "op" is "between". "between" is
  104. // "value <= * <= value2". "value" is used for all "op" values except "any".
  105. // "value" and "value2" are in the format of x, x.x, x.x.x, etc.
  106. // Only "driver_version" supports lexical style if the format is major.minor;
  107. // in that case, major is still numerical, but minor is lexical.
  108. // Only "driver_version" supports "(intel|nvidia)_driver" schema.
  109. //
  110. // intel_driver schema versions have the form like "AA.BB.(CC|CCC).DDDD". The
  111. // last two fields are most relevant, and the first two will be ignored by
  112. // setting them to 0. Thus "0.0.(CC|CCC).DDDD" will be used in comparison
  113. // following the general rule.
  114. //
  115. // FLOAT includes "op" "value", and "value2". "op" can be any of the
  116. // following values: "=", "<", "<=", ">", ">=", "any", "between". "value2" is
  117. // only used if "op" is "between". "value" is used for all "op" values except
  118. // "any". "value" and "value2" are valid float numbers.
  119. // INT is very much like FLOAT, except that the values need to be integers.
  120. //
  121. // String pattern syntax can be found at
  122. // https://github.com/google/re2/blob/master/doc/syntax.txt