[llvm-commits] CVS: llvm/docs/LangRef.html

[John Criswell]

Changes in directory llvm/docs:

LangRef.html updated: 1.59 -> 1.60

---
Log message:

Corrected the descriptions of the llvm.writeport and llvm.writeio
intrinsics.

Modified llvm.readio and llvm.writeio to use pointers to memory instead
of integers.  This should take care of problems such as different pointer
sizes, casting integers to pointers, weird architectural pointer types, etc.

Re-worded the description of llvm.readio and llvm.writeio so that it should
be more clear as to why they should be used over regular loads/stores for
I/O.



---
Diffs of the changes:  (+32 -29)

Index: llvm/docs/LangRef.html
diff -u llvm/docs/LangRef.html:1.59 llvm/docs/LangRef.html:1.60
--- llvm/docs/LangRef.html:1.59	Mon Apr 12 10:02:16 2004
+++ llvm/docs/LangRef.html	Mon Apr 12 11:33:19 2004
@@ -2077,13 +2077,13 @@
 <h5>Arguments:</h5>
 
 <p>
-The first argument to this intrinsic indicates the hardware I/O address to
-which data should be written.  The address is in the hardware I/O address
-namespace (as opposed to being a memory location for memory mapped I/O).
+The first argument is the value to write to the I/O port.
 </p>
 
 <p>
-The second argument is the value to write to the I/O port.
+The second argument indicates the hardware I/O address to which data should be
+written.  The address is in the hardware I/O address namespace (as opposed to
+being a memory location for memory mapped I/O).
 </p>
 
 <h5>Semantics:</h5>
@@ -2107,7 +2107,7 @@
 
 <h5>Syntax:</h5>
 <pre>
-  call <integer type> (<integer type>)* %llvm.readio (<integer type> <address>)
+  call <result> (<ty>*)* %llvm.readio (<ty> * <pointer>)
 </pre>
 
 <h5>Overview:</h5>
@@ -2120,24 +2120,28 @@
 <h5>Arguments:</h5>
 
 <p>
-The argument to this intrinsic indicates the memory address from which to read
-the data.
+The argument to this intrinsic is a pointer indicating the memory address from
+which to read the data.  The data must be a
+<a href="#t_firstclass">first class</a> type.
 </p>
 
 <h5>Semantics:</h5>
 
 <p>
 The '<tt>llvm.readio</tt>' intrinsic reads data from a memory mapped I/O
-location specified by <i>address</i> and returns the value.  The address and
-return value must be integers, but the size allowed for each is dependent upon
-the platform upon which the program is code generated.
+location specified by <i>pointer</i> and returns the value.  The argument must
+be a pointer, and the return value must be a
+<a href="#t_firstclass">first class</a> type.  However, certain architectures
+may not support I/O on all first class types.  For example, 32 bit processors
+may only support I/O on data types that are 32 bits or less.
 </p>
 
 <p>
-This intrinsic ensures that the I/O data read occurs in instruction order in
-relation to other I/O data reads and writes (as opposed to a normal load, where
-hardware scheduling can re-arrange the actual memory accesses to occur out of
-order).
+This intrinsic enforces an in-order memory model for llvm.readio and
+llvm.writeio calls on machines that use dynamic scheduling.  Dynamically
+scheduled processors may execute loads and stores out of order, re-ordering at
+run time accesses to memory mapped I/O registers.  Using these intrinsics
+ensures that accesses to memory mapped I/O registers occur in program order.
 </p>
 
 </div>
@@ -2151,7 +2155,7 @@
 
 <h5>Syntax:</h5>
 <pre>
-  call void (<integer type>, <integer type>)* %llvm.writeio (<integer type> <value>, <integer type> <address>)
+  call void (<ty1>, <ty2>*)* %llvm.writeio (<ty1> <value>, <ty2> * <pointer>)
 </pre>
 
 <h5>Overview:</h5>
@@ -2164,28 +2168,27 @@
 <h5>Arguments:</h5>
 
 <p>
-The first argument to this intrinsic indicates the memory address to which data
-should be written.
-</p>
-
-<p>
-The second argument is the value to write to the memory mapped I/O location.
+The first argument is the value to write to the memory mapped I/O location.
+The second argument is a pointer indicating the memory address to which the
+data should be written.
 </p>
 
 <h5>Semantics:</h5>
 
 <p>
 The '<tt>llvm.writeio</tt>' intrinsic writes <i>value</i> to the memory mapped
-I/O address specified by <i>address</i>.  The address and value must be
-integers, but the size is dependent upon the platform upon which the program is
-code generated.
+I/O address specified by <i>pointer</i>.  The value must be a
+<a href="#t_firstclass">first class</a> type.  However, certain architectures
+may not support I/O on all first class types.  For example, 32 bit processors
+may only support I/O on data types that are 32 bits or less.
 </p>
 
 <p>
-This intrinsic ensures that the I/O data write occurs in instruction order in
-relation to other I/O data reads and writes (as opposed to a normal store,
-where hardware scheduling can re-arrange the actual memory accesses to occur
-out of order).
+This intrinsic enforces an in-order memory model for llvm.readio and
+llvm.writeio calls on machines that use dynamic scheduling.  Dynamically
+scheduled processors may execute loads and stores out of order, re-ordering at
+run time accesses to memory mapped I/O registers.  Using these intrinsics
+ensures that accesses to memory mapped I/O registers occur in program order.
 </p>
 
 </div>
@@ -2387,7 +2390,7 @@
 
   <a href="mailto:sabre at nondot.org">Chris Lattner</a><br>
   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
-  Last modified: $Date: 2004/04/12 15:02:16 $
+  Last modified: $Date: 2004/04/12 16:33:19 $
 </address>
 </body>
 </html>