Embedded Peripherals IP User Guide

ID 683130
Date 8/15/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
1. Introduction 2. Avalon® -ST Multi-Channel Shared Memory FIFO Core 3. Avalon® -ST Single-Clock and Dual-Clock FIFO Cores 4. Avalon® -ST Serial Peripheral Interface Core 5. SPI Core 6. SPI Agent/JTAG to Avalon® Host Bridge Cores 7. Intel eSPI Agent Core 8. eSPI to LPC Bridge Core 9. Ethernet MDIO Core 10. Intel FPGA 16550 Compatible UART Core 11. UART Core 12. JTAG UART Core 13. Intel FPGA Avalon® Mailbox Core 14. Intel FPGA Avalon® Mutex Core 15. Intel FPGA Avalon® I2C (Host) Core 16. Intel FPGA I2C Agent to Avalon® -MM Host Bridge Core 17. Intel FPGA Avalon® Compact Flash Core 18. EPCS/EPCQA Serial Flash Controller Core 19. Intel FPGA Serial Flash Controller Core 20. Intel FPGA Serial Flash Controller II Core 21. Intel FPGA Generic QUAD SPI Controller Core 22. Intel FPGA Generic QUAD SPI Controller II Core 23. Interval Timer Core 24. Intel FPGA Avalon FIFO Memory Core 25. On-Chip Memory (RAM and ROM) Intel FPGA IP 26. On-Chip Memory II (RAM or ROM) Intel FPGA IP 27. Optrex 16207 LCD Controller Core 28. PIO Core 29. PLL Cores 30. DMA Controller Core 31. Modular Scatter-Gather DMA Core 32. Scatter-Gather DMA Controller Core 33. SDRAM Controller Core 34. Tri-State SDRAM Core 35. Video Sync Generator and Pixel Converter Cores 36. Intel FPGA Interrupt Latency Counter Core 37. Performance Counter Unit Core 38. Vectored Interrupt Controller Core 39. Avalon® -ST Data Pattern Generator and Checker Cores 40. Avalon® -ST Test Pattern Generator and Checker Cores 41. System ID Peripheral Core 42. Avalon® Packets to Transactions Converter Core 43. Avalon® -ST Multiplexer and Demultiplexer Cores 44. Avalon® -ST Bytes to Packets and Packets to Bytes Converter Cores 45. Avalon® -ST Delay Core 46. Avalon® -ST Round Robin Scheduler Core 47. Avalon® -ST Splitter Core 48. Avalon® -MM DDR Memory Half Rate Bridge Core 49. Intel FPGA GMII to RGMII Converter Core 50. Intel FPGA MII to RMII Converter Core 51. HPS GMII to TSE 1000BASE-X/SGMII PCS Bridge Core Intel® FPGA IP 52. Intel FPGA HPS EMAC to Multi-rate PHY GMII Adapter Core 53. Intel FPGA MSI to GIC Generator Core 54. Cache Coherency Translator Intel® FPGA IP 55. Lightweight UART Core

11.4.1.1.1. UART API

Table 89.  altera_avalon_uart_close altera_avalon_uart_close is not available for small driver.
Prototype int altera_avalon_uart_close(altera_avalon_uart_state* sp, int flags);
Include <altera_avalon_uart.h>
Parameters
  • sp - the UART device to close
  • flags - for indicating blocking/non-blocking access for single/multi-threaded
Returns None
Description Closes UART device
Table 90.  altera_avalon_uart_read
Prototype int altera_avalon_uart_read(altera_avalon_uart_state* sp, char* ptr, int len, int flags);
Include <altera_avalon_uart.h>
Parameters
  • sp - the UART device
  • ptr - destination address
  • len - maximum length of the data
  • flags - for indicating blocking/non-blocking access for single/multi-threaded
Returns Number of bytes read
Description Reads data to the UART receiver buffer
Table 91.  altera_avalon_uart_write
Prototype int altera_avalon_uart_write(altera_avalon_uart_state* sp, char* ptr, int len, int flags);
Include <altera_avalon_uart.h>
Parameters
  • sp - the UART device
  • ptr - source address
  • len - maximum length of the data
  • flags - for indicating blocking/non-blocking access for single/multi-threaded
Returns Number of bytes written
Description Writes data to the UART receiver buffer
Table 92.  altera_avalon_uart_irq altera_avalon_uart_irq is not available for small driver.
Prototype static void altera_avalon_uart_irq(void* context)
Include <altera_avalon_uart.h>
Parameters
  • context - the UART device
Returns None
Description Interrupt handler to process UART interrupts to process receiver/transmitter interrupts
Table 93.  altera_avalon_uart_rxirq altera_avalon_uart_rxirq is not available for small driver.
Prototype static void altera_avalon_uart_rxirq(altera_avalon_uart_state* sp, alt_u32 status)
Include <altera_avalon_uart.h>
Parameters
  • sp - the UART device
  • status - individual bits that indicate conditions inside the UART core
Returns None
Description Process a receive interrupt. It transfers the incoming character into the receiver circular buffer and sets the appropriate flags to indicate that there is data ready to be processed
Table 94.  altera_avalon_uart_txirq altera_avalon_uart_txirq is not available for small driver.
Prototype static void altera_avalon_uart_txirq(altera_avalon_uart_state* sp, alt_u32 status)
Include <altera_avalon_uart.h>
Parameters
  • sp - the UART device
  • status - individual bits that indicate conditions inside the UART core
Returns None
Description Process a transmit interrupt. It transfers data from the transmit buffer to the device and sets the appropriate flags to indicate that there is data ready to be processed