From 3c833b7e4500c24bf867f9103e67a546c0845954 Mon Sep 17 00:00:00 2001 From: Jens Owen Date: Thu, 18 Dec 2014 07:08:39 -0700 Subject: Update README.md start to push detailed descriptions down a level... --- README.md | 27 +++++++++------------------ icd/README | 19 ------------------- icd/README.md | 25 +++++++++++++++++++++++++ 3 files changed, 34 insertions(+), 37 deletions(-) delete mode 100644 icd/README create mode 100644 icd/README.md diff --git a/README.md b/README.md index 972f493b..695f32f1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Explicit GL (XGL) Ecosystem Components -*Version 0.7, 17 Dec 2014* +*Version 0.7, 18 Dec 2014* This project provides *open source* tools for XGL Developers. @@ -19,26 +19,17 @@ early insights into the specification of XGL and to assists those doing prototyping at this point. The following components are available: -- Proposed Reference [*ICD Loader*](loader) (including [*Layer Management*](layers/README.md)) -- Proposed Reference [*Validation Layers*](layers/) - - [Object Tracker](layers/object_track.c) - - [Draw State](layers/draw_state.c) - - [MemTracker](layers/mem_tracker.c) +- XGL Library and header files, which include: + - [*ICD Loader*](loader) and [*Layer Manager*](layers/README.md) + - Snapshot of *XGL* and *BIL* header files from [*Khronos*](www.khronos.org) + - [*GLAVE Debugger*](tools/glave) - - APIDump (generated) - - APIDumpFile (generated) - - glvtrace64: capture trace of XGL API of an application. - - glvreplay64: replay captured trace. - - screenshot: ![ScreenShot](docs/images/Glave-Small.png) - -- [*Sample Drivers*](icd) - - [Common Infrastructure](icd/common) - - [Implementation for Intel GPUs](icd/intel) -- [*Sample Driver Tests*](tests) - - Now includes Golden images to verify xgl_render_tests rendering. + +- Core [*Validation Layers*](layers/) + +- [*Sample Driver*](icd) ## New diff --git a/icd/README b/icd/README deleted file mode 100644 index cfa7b38a..00000000 --- a/icd/README +++ /dev/null @@ -1,19 +0,0 @@ -common/ provides helper and utility functions, as well as all XGL entry points -except xglInitAndEnumerateGpus. Hardware drivers are required to provide that -function, and to embed a "XGL_LAYER_DISPATCH_TABLE *" as the first member of -XGL_PHYSICAL_GPU and all XGL_BASE_OBJECT. - -Thread safety - - We have these static variables - - - common/icd.c:static struct icd icd; - - intel/gpu.c:static struct intel_gpu *intel_gpus; - - They require that there is no other thread calling the ICD when these - functions are called - - - xglInitAndEnumerateGpus - - xglDbgRegisterMsgCallback - - xglDbgUnregisterMsgCallback - - xglDbgSetGlobalOption diff --git a/icd/README.md b/icd/README.md new file mode 100644 index 00000000..0edaa05d --- /dev/null +++ b/icd/README.md @@ -0,0 +1,25 @@ +This sample driver implementation provide multiple subcomponents required to build and test an Installable Client Driver (ICD): +- [Common Infrastructure](common) +- [Implementation for Intel GPUs](intel) +- [*Sample Driver Tests*](../tests) + - Now includes Golden images to verify xgl_render_tests rendering. + +common/ provides helper and utility functions, as well as all XGL entry points +except xglInitAndEnumerateGpus. Hardware drivers are required to provide that +function, and to embed a "XGL_LAYER_DISPATCH_TABLE *" as the first member of +XGL_PHYSICAL_GPU and all XGL_BASE_OBJECT. + +Thread safety + + We have these static variables + + - common/icd.c:static struct icd icd; + - intel/gpu.c:static struct intel_gpu *intel_gpus; + + They require that there is no other thread calling the ICD when these + functions are called + + - xglInitAndEnumerateGpus + - xglDbgRegisterMsgCallback + - xglDbgUnregisterMsgCallback + - xglDbgSetGlobalOption -- cgit v1.2.3