base PDL 2 TEXI

1 files changed, 110 insertions, 0 deletions

diff --git a/doc/tools/pdl2texi/address.h b/doc/tools/pdl2texi/address.h
new file mode 100644
index 0000000000..82d73b917d
--- /dev/null
+++ b/doc/tools/pdl2texi/address.h
@@ -0,0 +1,110 @@
+/*  address.h
+ *
+ *  This include file contains the information required to manipulate
+ *  physical addresses.
+ *
+ *  COPYRIGHT (c) 1997.
+ *  On-Line Applications Research Corporation (OAR).
+ *  All rights reserved.
+ *
+ *  $Id$
+ */
+
+#ifndef __ADDRESSES_h
+#define __ADDRESSES_h
+
+/*
+ *  _Addresses_Add_offset
+ *
+ *  DESCRIPTION:
+ *
+ *  This function is used to add an offset to a base address.
+ *  It returns the resulting address.  This address is typically
+ *  converted to an access type before being used further.
+ */
+
+STATIC INLINE void *_Addresses_Add_offset ( 
+  void       *base, 
+  unsigned32  offset
+);
+
+/*
+ *  _Addresses_Subtract_offset
+ *
+ *  DESCRIPTION:
+ *
+ *  This function is used to subtract an offset from a base
+ *  address.  It returns the resulting address.  This address is
+ *  typically converted to an access type before being used further.
+ */
+
+STATIC INLINE void *_Addresses_Subtract_offset( 
+  void       *base, 
+  unsigned32  offset
+);
+
+/*
+ *  _Addresses_Add
+ *
+ *  DESCRIPTION:
+ *
+ *  This function is used to add two addresses.  It returns the
+ *  resulting address.  This address is typically converted to an
+ *  access type before being used further.
+ */
+
+STATIC INLINE void *_Addresses_Add ( 
+  void *left, 
+  void *right 
+);
+
+/*
+ *  _Addresses_Subtract
+ *
+ *  DESCRIPTION:
+ *
+ *  This function is used to subtract two addresses.  It returns the
+ *  resulting offset.
+ */
+
+STATIC INLINE unsigned32 _Addresses_Subtract ( 
+  void *left, 
+  void *right 
+);
+
+/*
+ *  _Addresses_Is_aligned
+ *
+ *  DESCRIPTION:
+ *
+ *  This function returns TRUE if the given address is correctly
+ *  aligned for this processor and FALSE otherwise.  Proper alignment
+ *  is based on correctness and efficiency.
+ */
+
+STATIC INLINE boolean _Addresses_Is_aligned ( 
+  void *address
+);
+
+/*
+ *  _Addresses_Is_in_range
+ *
+ *  DESCRIPTION:
+ *
+ *  This function returns TRUE if the given address is within the
+ *  memory range specified and FALSE otherwise.  base is the address
+ *  of the first byte in the memory range and limit is the address
+ *  of the last byte in the memory range.  The base address is
+ *  assumed to be lower than the limit address.
+ */
+
+STATIC INLINE boolean _Addresses_Is_in_range ( 
+  void *address, 
+  void *base,
+  void *limit 
+);
+
+#include "address.inl"
+
+#endif
+/* end of include file */