OpenAMP Release 2023.10.0 - v1.5.0

This release

• improves independence of the VIRTIO and remoteproc VIRTIO transport layer,
• introduces the VIRTIO MMIO native transport layer support, this is a first step to support VIRTIO protocol in the open-amp library,
• updates the cache management,
• improves the documentation with Doxygen,
• fixes various bugs.

API Updates:

Deprecated APIs:

• virtio_describe() function,
• WITH_DCACHE_VRINGS, WITH_DCACHE_BUFFERS, WITH_DCACHE_RSC_TABLE cmake options replaced by an unique option WITH_DCACHE.

updated APIs:

• virtio:
  • virtio_dispatch structure ; update create_virtqueues() ops parameter

New APIs:

• virtio:

  • virtio_get_devid(): get the virtio device type,

  • virtio_delete_virtqueues(): Delete the virtio device virtqueue,

  • virtio_get_status(): Set device status,

  • virtio_set_status(): Set device status,

  • virtio_read_config(): Retrieve configuration data from the device

  • virtio_write_config(): Write configuration data to the device

  • virtio_set_features(): set features supported by the VIRTIO driver,

  • virtio_get_features(): get features supported by the VIRTIO driver,

  • virtio_negotiate_features(): negotiate features between virtio device and driver,

  • virtio_reset_device(): reset the virtio device.

  • virtio_dispatch structure:

    • create_virtqueues: new ops to create a virtqueues,
    • delete_virtqueues: new ops to delete virtqueues.

• virtio-mmio:

  • virtio_mmio_register_device(): register a VIRTIO device,
  • virtio_mmio_setup_virtqueue(): setup a virtqueue structure,
  • virtio_mmio_device_init(): VIRTIO MMIO device initialization.

• virtqueue:

  • virtqueue_empty(): test if virtqueue is empty,
  • virtqueue_full(): test if virtqueue is full.

What's Changed

• apps: zynqmp: Add Versal_net IPI values. by @bentheredonethat in #490
• CI: update checkout action to V3 by @arnopo in #492
• virtio: follow virtio 1.2 spec, add more virtio status and device id by @CV-Bowen in #493
• CI: Fix checkpatch by @arnopo in #497
• virtio: add create_virtqueues and delete_virtqueues in virtio_dispatch by @CV-Bowen in #495
• remoteproc: do cache invalidation before reading rsc_table status by @iuliana-prodan in #500
• Virtio native support for lib openamp by @danmilea in #494
• CI: Fix Zephyr build by updating Zephyr SDK version to 0.16.1 by @arnopo in #504
• Updates and clean-up cache management by @iuliana-prodan in #502
• Doxygen updates for data structures by @tammyleino in #507
• Refactor VRING macros for AMP VIRTIO by @danmilea in #505
• Docs: enable readthedocs rendering (for PRs) by @wmamills in #511
• Doxygen update for virtio structures by @arnopo in #510
• github action: add stales action by @arnopo in #512
• Docs: style doxygen when built as part of OpenAMP docs by @wmamills in #516
• virtio: make unused function virtio_describe() deprecated by @arnopo in #509
• virtio: Fix delete_virtqueues function by @arnopo in #527
• github action: Fix stales action to not close PR/issue after 7 days by @arnopo in #528
• Readme improvement for v2023.10 release by @arnopo in #530
• release: open-amp 2023.10.0 by @arnopo in #531

New Contributors

• @CV-Bowen made their first contribution in #493
• @iuliana-prodan made their first contribution in #500
• @wmamills made their first contribution in #511

Full Changelog: v2023.04.0...v2023.10.0