1f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org/********************************************************** 2f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * Copyright 2009-2011 VMware, Inc. All rights reserved. 3f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * 4f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * Permission is hereby granted, free of charge, to any person 5f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * obtaining a copy of this software and associated documentation 6f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * files (the "Software"), to deal in the Software without 7f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * restriction, including without limitation the rights to use, copy, 8f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * modify, merge, publish, distribute, sublicense, and/or sell copies 9f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * of the Software, and to permit persons to whom the Software is 10f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * furnished to do so, subject to the following conditions: 11f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * 12f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * The above copyright notice and this permission notice shall be 13f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * included in all copies or substantial portions of the Software. 14f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * 15f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 16f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 17f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 18f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 19f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 20f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 21f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * SOFTWARE. 23f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * 24f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org ********************************************************* 25f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * Authors: 26f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * Zack Rusin <zackr-at-vmware-dot-com> 27f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org * Thomas Hellstrom <thellstrom-at-vmware-dot-com> 28f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org */ 29f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 30f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgThe XA state tracker is intended as a versioned interface to gallium for 31f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgxorg driver writers. Initially it's mostly based on Zack Rusin's 32f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgcomposite / video work for the Xorg state tracker. 33f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 34f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgThe motivation behind this state tracker is that the Xorg state tracker has 35f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orga number of interfaces to work with: 36f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 37f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org1) The Xorg sdk (versioned) 38f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org2) Gallium3D (not versioned) 39f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org3) KMS modesetting (versioned) 40f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org4) Driver-private (hopefully versioned) 41f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 42f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgSince Gallium3D is not versioned, the Xorg state tracker needs to be compiled 43f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgwith Gallium, but it's really beneficial to be able to compile xorg drivers 44f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgstandalone. 45f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 46f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgTherefore the xa state tracker is intended to supply the following 47f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgfunctionality: 48f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 49f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org1) Versioning. 50f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org2) Surface functionality (creation and copying for a basic dri2 implementation) 51f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org3) YUV blits for textured Xv. 52f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org4) Solid fills without ROP functionality. 53f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org5) Copies with format conversion and - reinterpretation but without ROP 54f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org6) Xrender- type compositing for general acceleration. 55f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 56f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 57f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgThe first user will be the vmwgfx xorg driver. When there are more users, 58f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgwe need to be able to load the appropriate gallium pipe driver, and we 59f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgshould investigate sharing the loadig mechanism with the EGL state tracker. 60f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 61f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgIMPORTANT: 62f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgVersion compatibilities: 63f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgWhile this library remains OUTSIDE any mesa release branch, 64f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.organd the major version number is still 0. Any minor bump should be viewed as 65f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.organ incompatibility event, and any user of this library should test for that 66f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.organd refuse to use the library if minor versions differ. 67f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgAs soon as the library enters a mesa release branch, if not earlier, major 68f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgwill be bumped to 1, and normal incompatibility rules (major bump) 69f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgwill be followed. 70f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgIt is allowed to add function interfaces while only bumping minor. Any 71f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orguser that uses these function interfaces must therefore use lazy symbol 72f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orglookups and test minor for compatibility before using such a function. 73