Embedded Peripherals IP User Guide

ID 683130
Date 10/24/2025
Public
Document Table of Contents
1. Introduction 2. Avalon® -ST Serial Peripheral Interface Core 3. SPI Core 4. SPI Agent/JTAG to Avalon® Host Bridge Cores 5. Intel eSPI Agent Core 6. eSPI to LPC Bridge Core 7. Ethernet MDIO Core 8. Intel FPGA 16550 Compatible UART Core 9. UART Core 10. Lightweight UART Core 11. JTAG UART Core 12. Intel FPGA Avalon® Mailbox Core 13. Intel FPGA Avalon® Mutex Core 14. Intel FPGA Avalon® I2C (Host) Core 15. Intel FPGA I2C Agent to Avalon® -MM Host Bridge Core 16. EPCS/EPCQA Serial Flash Controller Core 17. Intel FPGA Serial Flash Controller Core 18. Intel FPGA Serial Flash Controller II Core 19. Intel FPGA Generic QUAD SPI Controller Core 20. Intel FPGA Generic QUAD SPI Controller II Core 21. Interval Timer Core 22. Intel FPGA Avalon FIFO Memory Core 23. On-Chip Memory (RAM and ROM) Intel FPGA IP 24. On-Chip Memory II (RAM or ROM) Intel FPGA IP 25. PIO Core 26. PLL Cores 27. DMA Controller Core 28. Modular Scatter-Gather DMA Core 29. Scatter-Gather DMA Controller Core 30. Video Sync Generator and Pixel Converter Cores 31. Intel FPGA Interrupt Latency Counter Core 32. Performance Counter Unit Core 33. Vectored Interrupt Controller Core 34. System ID Peripheral Core 35. Intel FPGA GMII to RGMII Converter Core 36. HPS GMII to RGMII Adapter IP 37. Intel FPGA MII to RMII Converter Core 38. HPS GMII to TSE 1000BASE-X/SGMII PCS Bridge Core IP 39. Intel FPGA HPS EMAC to Multi-rate PHY GMII Adapter Core 40. Intel FPGA MSI to GIC Generator Core 41. Cache Coherency Translator IP 42. Altera ACE5-Lite Cache Coherency Translator

16.6. Driver API

Table 168.  alt_epcs_flash_get_info
Prototype: alt_epcs_flash_get_info(alt_flash_fd* fd, flash_region** info, int* number_of_regions)
Include: <altera_avalon_epcs_flash_controller.h>
Parameter:
  • fd – pointer to general flash device structure
  • info- pointer to the flash region
  • number_of_regions- pointer to the number of regions
Return: Return 0 if successful and otherwise return:
  • -ENOMEM for number of region more than maximum number of flash region
  • -EIO for possibly hardware problem
Description: Pass the table of erase blocks to the user.
Table 169.  alt_epcs_flash_erase_block
Prototype: alt_epcs_flash_erase_block(alt_flash_dev* flash_info, int block_offset)
Include: <altera_avalon_epcs_flash_controller.h>
Parameter:
  • flash_info – pointer to flash device structure
  • block_offset- byte-addressed offset, from start of flash of the sector to be erased
Return: Return 0 if successful.
Description: Erase the selected erase block
Table 170.  alt_epcs_flash_write_block
Prototype: alt_epcs_flash_write_block(alt_flash_dev* flash_info, int block_offset, int data_offset, const void* data, int length)
Include: <altera_avalon_epcs_flash_controller.h>
Parameter:
  • flash_info – pointer to flash device structure
  • block_offset- the base of the current erase block
  • data_offset – absolute address of the beginning of the write-destination
  • data – data to be written
  • length – size of writing
Return: Return 0 if successful.
Description: Write one block/sector of data to the flash. The length of the write cannot spill into the adjacent sector.
Table 171.  alt_epcs_flash_write
Prototype: alt_epcs_flash_write (alt_flash_dev* flash_info, int offset, const void* src_addr, int length)
Include: <altera_avalon_epcs_flash_controller.h>
Parameter:
  • flash_info – pointer to flash device structure
  • offset- byte offset (unaligned access) of write to flash memory
  • src_addr – source buffer
  • length – size of writing
Return: Return 0 if successful.
Description: Program the data into the flash at the selected address. This function automatically erases a block as needed.
Table 172.  alt_epcs_flash_read
Prototype: alt_epcs_flash_read(alt_flash_dev* flash_info, int offset, void* dest_addr, int length)
Include: <altera_avalon_epcs_flash_controller.h>
Parameter:
  • flash_info – pointer to flash device structure
  • offset- offset read from flash memory
  • dest_addr – destination buffer
  • length – size of writing
Return: Return 0 if successful.
Description: Read data from flash at the selected address.