Changes between Version 4 and Version 5 of EEPROM_onewire


Ignore:
Timestamp:
Jul 28, 2006, 4:43:00 PM (18 years ago)
Author:
bratton
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • EEPROM_onewire

    v4 v5  
    88 * Readable 64-bit lasered ROM containing 8-bit family code, 48-bit serial code, and 8-bit Cyclic Redundancy check (CRC).
    99 * Readable 16-bit serial code given by WARP
    10  * The provided libaries are divided into OneWire_l.c and !OneWire.c -- The latter contains everything the User needs to drive the EEPROM.
    11  * The !OneWire.c library provides the following functionality:
     10 * The provided libaries are divided into EEPROM_l.c and EEPROM.c -- The latter contains everything the User needs to drive the EEPROM.
     11 * The EEPROM.c library provides the following functionality:
    1212   * Read valid calibration values that have been stored to a radio's EEPROM
     13
    1314   * Write calibration value to a radio's EEPROM
    1415   * Read valid MAC addresses of the FPGA board and radios from the FPGA's EEPROM
     
    1920   * Write data to the EEPROMs data pages
    2021
    21 A part of the header file !OneWire.h is given below.
     22A part of the header file EEPROM.h is given below.
    2223
    23 '''''short WarpOneWire_ReadRadioCal(unsigned int* baseaddr, char RxNTx, char val_select)'''''[[BR]]
     24'''''short WarpEEPROM_ReadRadioCal(unsigned int* baseaddr, char RxNTx, char val_select)'''''[[BR]]
    2425// This function checks to see if a valid calibration value is stored on the EEPROM[[BR]]
    2526// and returns the value if so.[[BR]]
    26 // baseaddr is the base address of the ONEWIRE device[[BR]]
     27// baseaddr is the base address of the EEPROM device[[BR]]
    2728// RxNTx specifies whether the values are the Rx or Tx values. 1 indicates Rx[[BR]]
    2829// val_select selects which value to write[[BR]]
     
    3132// the least significant byte is the I-value.[[BR]]
    3233
    33 '''''char WarpOneWire_WriteRadioCal(unsigned int* baseaddr, char RxNTx, char val_select, char I_val, char Q_val);'''''[[BR]]
     34'''''char WarpEEPROM_WriteRadioCal(unsigned int* baseaddr, char RxNTx, char val_select, char I_val, char Q_val);'''''[[BR]]
    3435// This functions writes a calibration value to the EEPROM[[BR]]
    35 // baseaddr is the base address of the ONEWIRE device[[BR]]
     36// baseaddr is the base address of the EEPROM device[[BR]]
    3637// RxNTx specifies whether the values are the Rx or Tx values. 1 indicates Rx[[[BR]]
    3738// val_select selects which value to write[[BR]]
     
    4142// Returns SUCCESS if all goes well, FAILURE otherwise[[BR]]
    4243
    43 '''''void WarpOneWire_ReadMACAddress(unsigned int* baseaddr, char dev_select, char *MAC);'''''[[BR]]
     44'''''void WarpEEPROM_ReadMACAddress(unsigned int* baseaddr, char dev_select, char *MAC);'''''[[BR]]
    4445// This function writes a 6-byte MAC address into a 6-byte array addressed by a pointer.[[BR]]
    45 // baseaddr is the base address of the ONEWIRE device[[BR]]
     46// baseaddr is the base address of the EEPROM device[[BR]]
    4647// dev_select specifies which device's MAC address to read[[BR]]
    4748//    0: FPGA Board   1: Radio1   2: Radio2   3: Radio3   4: Radio4[[BR]]
    4849// *MAC is a pointer to a 6-byte array[[BR]]
    4950
    50 '''''char WarpOneWire_WriteMACAddress(unsigned int* baseaddr, char dev_select, char *MAC);'''''[[BR]]
     51'''''char WarpEEPROM_WriteMACAddress(unsigned int* baseaddr, char dev_select, char *MAC);'''''[[BR]]
    5152// This function writes a 6-byte MAC address into the EEPROM.[[BR]]
    52 // baseaddr is the base address of the ONEWIRE device[[BR]]
     53// baseaddr is the base address of the EEPROM device[[BR]]
    5354// dev_select specifies which device's MAC address to read[[BR]]
    5455//    0: FPGA Board   1: Radio1   2: Radio2   3: Radio3   4: Radio4[[BR]]
     
    5657// Returns SUCCESS if all goes well, FAILURE otherwise[[BR]]
    5758
    58 '''''short WarpOneWire_ReadWARPSerial(unsigned int* baseaddr);'''''[[BR]]
     59'''''short WarpEEPROM_ReadWARPSerial(unsigned int* baseaddr);'''''[[BR]]
    5960// Returns the the 2-byte serial number assigned by Rice WARP[[BR]]
    6061
    61 '''''void WarpOneWire_ReadDSSerial(unsigned int* baseaddr, unsigned char *Serial);'''''[[BR]]
     62'''''void WarpEEPROM_ReadDSSerial(unsigned int* baseaddr, unsigned char *Serial);'''''[[BR]]
    6263// Get Serial number from a EEPROM device.  Assumes it is the only device on the bus.[[BR]]
    63 // baseaddr is the base address of the ONEWIRE device[[BR]]
     64// baseaddr is the base address of the EEPROM device[[BR]]
    6465// returns a memory array containing the 1 byte family code, 6 byte serial[[BR]]
    6566// serial number and 1 byte CRC value[[BR]]
    66 // Assumes the !OneWire master has been intialized.[[BR]]
    6767
    68 '''''char WarpOneWire_ReadUserMem(unsigned int* baseaddr, char page, char sector, unsigned char *array);'''''[[BR]]
    69 
     68'''''char WarpEEPROM_ReadUserMem(unsigned int* baseaddr, char page, char sector, unsigned char *array);'''''[[BR]]
    7069// This function reads from a specified memory location in the 1024-bit memory.[[BR]]
    7170// Returns an 8-byte sector of the EEPROM. [[BR]]
    72 // baseaddr is the base address of the ONEWIRE device[[BR]]
     71// baseaddr is the base address of the EEPROM device[[BR]]
    7372// page must be 1-3, and refers to memory pages on the device[[BR]]
    7473// sector must be 1-3, and refers to the appropriate sector on the device[[BR]]
     
    7675// Returns SUCCESS if no error, otherwise FAILURE[[BR]]
    7776
    78 '''''char WarpOneWire_WriteUserMem(unsigned int* baseaddr, char page, char sector, unsigned char *array);'''''[[BR]]
     77'''''char WarpEEPROM_WriteUserMem(unsigned int* baseaddr, char page, char sector, unsigned char *array);'''''[[BR]]
    7978// Writes a given 8-byte array to a designated location in memory.[[BR]]
    8079// Essentially a wrapper of the !WriteScratch, !ReadScratch and Scratch2Mem functions[[BR]]
    81 // baseaddr is the base address of the ONEWIRE device[[BR]]
     80// baseaddr is the base address of the EEPROM device[[BR]]
    8281// page must be 1-3, and refers to memory pages on the device[[BR]]
    8382// sector must be 1-3, and refers to the appropriate sector on the device[[BR]]