miext: damage: document DamageScreenFuncsRec

This struct (and associated functions) needs to be part of public driver ABI,
so video drivers can get notifications on damage certain operations, but
there hasn't been any documentation on it.

Signed-off-by: Enrico Weigelt, metux IT consult <info@metux.net>

hw/kdrive/ephyr/ephyrinit.c

@@ -370,23 +370,6 @@ ddxProcessArgument(int argc, char **argv, int i)
     return KdProcessArgument(argc, argv, i);
 }
 
-static int
-EphyrInit(void)
-{
-    /*
-     * make sure at least one screen
-     * has been added to the system.
-     */
-    if (!KdCardInfoLast()) {
-        processScreenArg("640x480", NULL);
-    }
-    return hostx_init();
-}
-
-KdOsFuncs EphyrOsFuncs = {
-    .Init = EphyrInit,
-};
-
 void
 OsVendorInit(void)
 {
@@ -398,7 +381,12 @@ OsVendorInit(void)
     if (hostx_want_host_cursor())
         ephyrFuncs.initCursor = &ephyrCursorInit;
 
-    KdOsInit(&EphyrOsFuncs);
+    if (serverGeneration == 1) {
+        if (!KdCardInfoLast()) {
+            processScreenArg("640x480", NULL);
+        }
+        hostx_init();
+    }
 }
 
 KdCardFuncs ephyrFuncs = {

hw/kdrive/src/kdrive.c

@@ -91,14 +91,6 @@ const char *kdGlobalXkbLayout = NULL;
 const char *kdGlobalXkbVariant = NULL;
 const char *kdGlobalXkbOptions = NULL;
 
-
-/*
- * Carry arguments from InitOutput through driver initialization
- * to KdScreenInit
- */
-
-KdOsFuncs *kdOsFuncs = NULL;
-
 void
 KdDisableScreen(ScreenPtr pScreen)
 {
@@ -525,19 +517,6 @@ KdProcessArgument(int argc, char **argv, int i)
     return 0;
 }
 
-void
-KdOsInit(KdOsFuncs * pOsFuncs)
-{
-    kdOsFuncs = pOsFuncs;
-    if (pOsFuncs) {
-        if (serverGeneration == 1) {
-            KdDoSwitchCmd("start");
-            if (pOsFuncs->Init)
-                (*pOsFuncs->Init) ();
-        }
-    }
-}
-
 static Bool
 KdAllocatePrivates(ScreenPtr pScreen)
 {

hw/kdrive/src/kdrive.h

@@ -278,16 +278,6 @@ int KdAddConfigKeyboard(char *pointer);
 int KdAddKeyboard(KdKeyboardInfo * ki);
 void KdRemoveKeyboard(KdKeyboardInfo * ki);
 
-typedef struct _KdOsFuncs {
-    int (*Init) (void); /* Only called when the X server is started, when serverGeneration == 1 */
-    void (*Enable) (void);
-    Bool (*SpecialKey) (KeySym);
-    void (*Disable) (void);
-    void (*Fini) (void);
-    void (*pollEvents) (void);
-    void (*Bell) (int, int, int);
-} KdOsFuncs;
-
 typedef struct _KdPointerMatrix {
     int matrix[2][3];
 } KdPointerMatrix;
@@ -299,8 +289,6 @@ extern DevPrivateKeyRec kdScreenPrivateKeyRec;
 extern Bool kdEmulateMiddleButton;
 extern Bool kdDisableZaphod;
 
-extern KdOsFuncs *kdOsFuncs;
-
 #define KdGetScreenPriv(pScreen) ((KdPrivScreenPtr) \
     dixLookupPrivate(&(pScreen)->devPrivates, kdScreenPrivateKey))
 #define KdSetScreenPriv(pScreen,v) \
@@ -357,9 +345,6 @@ void
 int
  KdProcessArgument(int argc, char **argv, int i);
 
-void
- KdOsInit(KdOsFuncs * pOsFuncs);
-
 void
  KdOsAddInputDrivers(void);
 

miext/damage/damage.h

@@ -46,6 +46,18 @@ typedef void (*DamageScreenRegisterFunc) (DrawablePtr, DamagePtr);
 typedef void (*DamageScreenUnregisterFunc) (DrawablePtr, DamagePtr);
 typedef void (*DamageScreenDestroyFunc) (DamagePtr);
 
+/* @public
+ *
+ * @brief Driver callbacks for getting notified on several damage calls
+ *
+ * The pointer to this struct can be obtained via DamageGetScreenFuncs().
+ * Drivers can inject themselves here, in order to get notified on
+ * DamageCreate(), DamageRegister(), DamageUnregister(), DamageDestroy().
+ *
+ * This should ONLY be touched by video drivers, nobody else.
+ *
+ * So far the only one using it is the proprietary NVidia driver.
+ */
 typedef struct _damageScreenFuncs {
     DamageScreenCreateFunc Create;
     DamageScreenRegisterFunc Register;