knav-qmss.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. ======================================================================
  2. Texas Instruments Keystone Navigator Queue Management SubSystem driver
  3. ======================================================================
  4. Driver source code path
  5. drivers/soc/ti/knav_qmss.c
  6. drivers/soc/ti/knav_qmss_acc.c
  7. The QMSS (Queue Manager Sub System) found on Keystone SOCs is one of
  8. the main hardware sub system which forms the backbone of the Keystone
  9. multi-core Navigator. QMSS consist of queue managers, packed-data structure
  10. processors(PDSP), linking RAM, descriptor pools and infrastructure
  11. Packet DMA.
  12. The Queue Manager is a hardware module that is responsible for accelerating
  13. management of the packet queues. Packets are queued/de-queued by writing or
  14. reading descriptor address to a particular memory mapped location. The PDSPs
  15. perform QMSS related functions like accumulation, QoS, or event management.
  16. Linking RAM registers are used to link the descriptors which are stored in
  17. descriptor RAM. Descriptor RAM is configurable as internal or external memory.
  18. The QMSS driver manages the PDSP setups, linking RAM regions,
  19. queue pool management (allocation, push, pop and notify) and descriptor
  20. pool management.
  21. knav qmss driver provides a set of APIs to drivers to open/close qmss queues,
  22. allocate descriptor pools, map the descriptors, push/pop to queues etc. For
  23. details of the available APIs, please refers to include/linux/soc/ti/knav_qmss.h
  24. DT documentation is available at
  25. Documentation/devicetree/bindings/soc/ti/keystone-navigator-qmss.txt
  26. Accumulator QMSS queues using PDSP firmware
  27. ============================================
  28. The QMSS PDSP firmware support accumulator channel that can monitor a single
  29. queue or multiple contiguous queues. drivers/soc/ti/knav_qmss_acc.c is the
  30. driver that interface with the accumulator PDSP. This configures
  31. accumulator channels defined in DTS (example in DT documentation) to monitor
  32. 1 or 32 queues per channel. More description on the firmware is available in
  33. CPPI/QMSS Low Level Driver document (docs/CPPI_QMSS_LLD_SDS.pdf) at
  34. git://git.ti.com/keystone-rtos/qmss-lld.git
  35. k2_qmss_pdsp_acc48_k2_le_1_0_0_9.bin firmware supports upto 48 accumulator
  36. channels. This firmware is available under ti-keystone folder of
  37. firmware.git at
  38. git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git
  39. To use copy the firmware image to lib/firmware folder of the initramfs or
  40. ubifs file system and provide a sym link to k2_qmss_pdsp_acc48_k2_le_1_0_0_9.bin
  41. in the file system and boot up the kernel. User would see
  42. "firmware file ks2_qmss_pdsp_acc48.bin downloaded for PDSP"
  43. in the boot up log if loading of firmware to PDSP is successful.
  44. Use of accumulated queues requires the firmware image to be present in the
  45. file system. The driver doesn't acc queues to the supported queue range if
  46. PDSP is not running in the SoC. The API call fails if there is a queue open
  47. request to an acc queue and PDSP is not running. So make sure to copy firmware
  48. to file system before using these queue types.