FPGA Reusables
The many complex repetitive function of the FPGA call for modules that abstract this complexity or just clean up the code. The following is their list with a brief description of their function. They are listed roughly from the low level units to high level "wrappers".
Byte Fetcher (getByte)
Fetches a byte of data from the Ethernet Controller registers via the [FPGA_Transceiver|Transceiver]. This unit creates yet another abstraction layer "in series" with the transceiver. The two step process of sending a request with all accompanying parameters and waiting for reply is now a matter of a single "call". The module does not latch the input data but puts it immediately on the Transceiver control bus. (This is safe since the Transceiver latches the input data and starts the conversation with the EC on the falling edge of its fast clock - a full 25 ns after the rising edge of the "Go" signal sent to getByte).
Write Request (wrToAddr)
Sends a write request (R/W pin low) to [FPGA_Transceiver|Transceiver] at the specified address with the specified byte of data. The module awaits the "Done" signal from the Transceiver and passes it to the calling module.
2-byte Write Request (wr2BtoAddr)
Coordinates write operations to two adjacent 1-byte registers in the Ethernet Controller chip. This is an essential abstraction because the controller often requires 16-bit exchanges especially when specifying 16-bit locations pointers in random memory access. Only the address of the first register is passed in. Naturally [[FPGA_Reusables#Write Request (wrToAddr)|wrToAddr]] is used for the individual byte writes.
Auto-reader (AutoRd)
Performs the same function as the Byte Fetcher (described above) but is hard-wired to address the RXAUTORD (0x01). This is convenient because the Ethernet Controller's AutoRead interface will be used extensively to parse through packets. AutoRd is in fact just a wrapper around GetByte passing through all signals accept the fixed address input.
Random Access Write (RAwrToAddr)
Writing directly to Ethernet Controller RAM (not to be confused with the control registers) in random access mode requires more work. A 16-bit address needs to be passed in 8 bits at a time to appropriate control registers and the actual 8-bit data is sent on the third transaction. Because the buffer is sometimes loaded in sequentially, this unit is designed to just increment the address of the previous random access write if the passed in address has a '1' in the MSB. (This would never be a legal address, as it is out of range.) The calling module, therefore, does not need to store the current write location of the RAM. wr2BtoAddr and wrToAddr are very convenient for these three transactions.
2-byte Random Access Write (RAwr2BtoAddr)
Because the data values exchanged between the board and the PC range from 10 to 14 bit depth, zero padded 16-bit words will be used. So, to load this 2-byte word into the transfer buffer requires two random access writes. This module packages this functionality by including two calls to RAwrToAddr with address increments and input data latching taken into account.