<Driver Name>


Overview


Some introductory text about the driver and the IP, introducing the major features of the device.

Current Version: 2016.3

  • Recent change #1
  • Recent change #2

Features

  • Master mode
  • Support 16 bytes FIFO
  • Programmable normal and fast bus data rates
  • Interrupt support
  • Repeated start support using HOLD bit
  • FIFO control using HOLD bit

Known issues and limitations

Repeated start after a read transfer is not supported by this controller; a warning is given when this condition is detected by the driver.

To Be Fixed:

  • Issue #1 (<link to AR>)
  • Issue #2 (<link to AR>)

Errata:



Performance Benchmarks


Description of the benchmarks relevant to this IP. This section may not be relevant for all IP.

Configuration
Test #1
Test #2
Test #3
Normal
5
6
4
Fast
11
12
13

Interoperability


Optional section. List of interoperable devices (when appropriate/needed)

Recommended Topologies


Configuration #1:


Information here on recommended topologies. For some drivers/subsystems this will be very brief, and may even be a point-to-point connection. Should match what we have under test and be presented in a graphical form. If supporting IPs are required to use this IP, links should be provided and system-level considerations mentioned. Mention as many topologies as necessary based on IP subsystem (the expectation being that more complex IPs/subsystems will have more)

Xlnx DRM KMS.png


Supporting IPs



(*NOTE* The above links should be to wiki pages describing the configuration and setup of those drivers, not GitHub unless that really is the best available information)

Kernel Configuration Options

The following config options should be enabled in order to use the <driver name> in Linux

CONFIG_ETHERNET
CONFIG_NET_VENDOR_XILINX
CONFIG_XILINX_AXI_EMAC

Device tree node details


https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/ata/ahci-ceva.txt?id=refs/tags/v4.5-rc3

Binding for CEVA AHCI SATA Controller
 
Required properties:
  - reg: Physical base address and size of the controller's register area.
  - compatible: Compatibility string. Must be 'ceva,ahci-1v84'.
  - clocks: Input clock specifier. Refer to common clock bindings.
  - interrupts: Interrupt specifier. Refer to interrupt binding.
 
Optional properties:
  - ceva,broken-gen2: limit to gen1 speed instead of gen2.
 
Examples:
    ahci@fd0c0000 {
        compatible = "ceva,ahci-1v84";
        reg = <0xfd0c0000 0x200>;
        interrupt-parent = <&gic>;
        interrupts = <0 133 4>;
        clocks = <&clkc SATA_CLK_ID>;
        ceva,broken-gen2;
    };
 

Additional Information


Driver-specific, but could include examples of accessing the subsystem from user space, test applications, etc. Also should include links to any publicly-available information on using this driver such as reference designs, application notes, etc.