Document softmmu templates

Add some comments to describe each file.

Signed-off-by: Blue Swirl <blauwirbel@gmail.com>

diff --git a/softmmu_defs.h b/softmmu_defs.h
index e38bb752f1508032a4fed205e35a8eeda0ba813d..c5a2bcd3e21d645d3dd8e1350ea814f4535174d1 100644 (file)
--- a/softmmu_defs.h
+++ b/softmmu_defs.h
@@ -1,3 +1,11 @@
+/*
+ *  Software MMU support
+ *
+ * Declare helpers used by TCG for qemu_ld/st ops.
+ *
+ * Used by softmmu_exec.h, TCG targets and exec-all.h.
+ *
+ */
 #ifndef SOFTMMU_DEFS_H
 #define SOFTMMU_DEFS_H
 

diff --git a/softmmu_exec.h b/softmmu_exec.h
index 28d1d53d61e29e9ff628db5e763c53511f75157c..8c73985599f8ba5371c245c4e69b474010c91cc6 100644 (file)
--- a/softmmu_exec.h
+++ b/softmmu_exec.h
@@ -1,4 +1,14 @@
-/* Common softmmu definitions and inline routines.  */
+/*
+ *  Software MMU support
+ *
+ * Generate inline load/store functions for all MMU modes (typically
+ * at least _user and _kernel) as well as _data versions, for all data
+ * sizes.
+ *
+ * Used by target op helpers.
+ *
+ * MMU mode suffixes are defined in target cpu.h.
+ */
 
 /* XXX: find something cleaner.
  * Furthermore, this is false for 64 bits targets

diff --git a/softmmu_header.h b/softmmu_header.h
index 2f95c334094cf49f8ee0937ba35e481ccbc79029..818d7b662efca9abd4ba2b8346c2a5c3ebe494fe 100644 (file)
--- a/softmmu_header.h
+++ b/softmmu_header.h
@@ -1,6 +1,15 @@
 /*
  *  Software MMU support
  *
+ * Generate inline load/store functions for one MMU mode and data
+ * size.
+ *
+ * Generate a store function as well as signed and unsigned loads. For
+ * 32 and 64 bit cases, also generate floating point functions with
+ * the same size.
+ *
+ * Not used directly but included from softmmu_exec.h and exec-all.h.
+ *
  *  Copyright (c) 2003 Fabrice Bellard
  *
  * This library is free software; you can redistribute it and/or

diff --git a/softmmu_template.h b/softmmu_template.h
index c2df9ec2d4672fa23409aed827e466c92f6ff484..ae0ccf226c0c8b7d6df2ef8e264730b683c0dd38 100644 (file)
--- a/softmmu_template.h
+++ b/softmmu_template.h
@@ -1,6 +1,11 @@
 /*
  *  Software MMU support
  *
+ * Generate helpers used by TCG for qemu_ld/st ops and code load
+ * functions.
+ *
+ * Included from target op helpers and exec.c.
+ *
  *  Copyright (c) 2003 Fabrice Bellard
  *
  * This library is free software; you can redistribute it and/or