home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD v1.2 / amidev_cd_12.iso / inc&ad2.0 / text_autodocs / battmem.doc < prev    next >
Text File  |  1992-09-01  |  3KB  |  124 lines
  1. TABLE OF CONTENTS
  2.  
  3. battmem.resource/ObtainBattSemaphore
  4. battmem.resource/ReadBattMem
  5. battmem.resource/ReleaseBattSemaphore
  6. battmem.resource/WriteBattMem
  7. battmem.resource/ObtainBattSemaphore     battmem.resource/ObtainBattSemaphore
  8.  
  9.    NAME
  10.     ObtainBattSemaphore -- Obtain access to nonvolatile ram. (V36)
  11.  
  12.    SYNOPSIS
  13.     ObtainBattSemaphore( )
  14.  
  15.     void ObtainBattSemaphore( void );
  16.  
  17.    FUNCTION
  18.     Aquires exclusive access to the system nonvolatile ram.
  19.  
  20.    INPUTS
  21.  
  22.    RESULTS
  23.  
  24.    NOTES
  25.  
  26.    SEE ALSO
  27.  
  28.    BUGS
  29.  
  30. battmem.resource/ReadBattMem                     battmem.resource/ReadBattMem
  31.  
  32.    NAME
  33.     ReadBattMem -- Read a bitstring from nonvolatile ram.  (V36)
  34.  
  35.    SYNOPSIS
  36.     Error = ReadBattMem( Buffer, Offset, Len )
  37.     D0                   A0      D0      D1
  38.  
  39.     ULONG ReadBattMem( APTR, ULONG, ULONG );
  40.  
  41.    FUNCTION
  42.     Read a bitstring from nonvolatile ram.
  43.  
  44.    INPUTS
  45.     Buffer          Where to put the bitstring.
  46.     Offset          Bit offset of first bit to read.
  47.     Len             Length of bitstring to read.
  48.  
  49.    RESULTS
  50.     Error           Zero if no error.
  51.  
  52.    NOTES
  53.     The battery-backed memory is checksummed. If a checksum error
  54.     is detected, all bits in the battery-backed memory are
  55.     silently set to zero.
  56.  
  57.     Bits in the battery-backed memory that do not exist are read
  58.     as zero.
  59.  
  60.     Partial byte reads (less than 8 bits) result in the bits read
  61.     being put in the low-order bits of the destination byte.
  62.  
  63.    SEE ALSO
  64.  
  65.    BUGS
  66.  
  67. battmem.resource/ReleaseBattSemaphore   battmem.resource/ReleaseBattSemaphore
  68.  
  69.    NAME
  70.     ReleaseBattSemaphore -- Allow nonvolatile ram to others.  (V36)
  71.  
  72.    SYNOPSIS
  73.     ReleaseBattSemaphore( )
  74.  
  75.     void ReleaseBattSemaphore( void );
  76.  
  77.    FUNCTION
  78.     Relinquish exclusive access to the system nonvolatile ram.
  79.  
  80.    INPUTS
  81.  
  82.    RESULTS
  83.  
  84.    NOTES
  85.  
  86.    SEE ALSO
  87.  
  88.    BUGS
  89.  
  90. battmem.resource/WriteBattMem                   battmem.resource/WriteBattMem
  91.  
  92.    NAME
  93.     WriteBattMem -- Write a bitstring to nonvolatile ram.  (V36)
  94.  
  95.    SYNOPSIS
  96.     Error = WriteBattMem( Buffer, Offset, Len )
  97.     D0                    A0      D0      D1
  98.  
  99.     ULONG WriteBattMem( APTR, ULONG, ULONG );
  100.  
  101.    FUNCTION
  102.     Write a bitstring to the nonvolatile ram.
  103.  
  104.    INPUTS
  105.     Buffer          Where to get the bitstring.
  106.     Offset          Bit offset of first bit to write.
  107.     Len             Length of bitstring to write.
  108.  
  109.    RESULTS
  110.     Error           Zero if no error.
  111.  
  112.    NOTES
  113.     The battery-backed memory is checksummed. If a checksum error
  114.     is detected, all bits in the battery-backed memory are
  115.     silently set to zero.
  116.  
  117.     Partial byte writes (less than 8 bits) result in the bits
  118.     written being read from the low-order bits of the source byte.
  119.  
  120.    SEE ALSO
  121.  
  122.    BUGS
  123.  
  124.