Skip to content

luci-app-ppe-qos: add a page for the PPE hardware QoS classifiers #8965

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JuliusBairaktaris wants to merge 1 commit into
base: master
Choose a base branch
from
Open

luci-app-ppe-qos: add a page for the PPE hardware QoS classifiers #8965

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions applications/luci-app-ppe-qos/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Copyright 2026 Julius Bairaktaris <julius@bairaktaris.de>
# Licensed to the public under the Apache License 2.0.

include $(TOPDIR)/rules.mk

PKG_MAINTAINER:=Julius Bairaktaris <julius@bairaktaris.de>
PKG_LICENSE:=Apache-2.0

LUCI_TITLE:=LuCI support for the Qualcomm PPE hardware QoS classifiers
LUCI_DEPENDS:=+ppe-qos
LUCI_PKGARCH:=all

include ../../luci.mk

# call BuildPackage - OpenWrt buildroot signature
137 changes: 137 additions & 0 deletions applications/luci-app-ppe-qos/htdocs/luci-static/resources/view/network/ppe-qos.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
'use strict';
'require view';
'require form';

var CLASSES = [
[ 'cs0', _('CS0 - best effort') ],
[ 'cs1', _('CS1 - scavenger / bulk') ],
[ 'cs3', _('CS3 - broadcast video') ],
[ 'af31', _('AF31 - multimedia streaming') ],
[ 'cs4', _('CS4 - real-time interactive (games)') ],
[ 'af41', _('AF41 - multimedia conferencing (calls)') ],
[ 'cs5', _('CS5 - signalling, DNS') ],
[ 'ef', _('EF - voice bearer') ],
[ 'cs6', _('CS6 - network control') ]
];

function prio_options(o) {
for (var i = 0; i <= 7; i++)
o.value(i, i >= 4 ? _('Priority %d (served past the bulk queue)').format(i)
: _('Priority %d (bulk queue)').format(i));
}

return view.extend({
render: function() {
var m, s, o;

m = new form.Map('ppe-qos', _('PPE Hardware QoS'),
_('Which egress queue of the switch a flow rides. A marking rule puts a DSCP on the flow, ' +
'a map turns that DSCP into an internal priority, and the priority picks the queue: ' +
'priorities 4 and up are served past the bulk queue of a shaped port, so marked traffic ' +
'keeps idle latency while the bulk queue stays deep enough for full throughput. ' +
'Marking is done by the switch itself, so it reaches flows the PPE has offloaded. ' +
'Shaper rates and the bulk queue depth belong to SQM (hw_ppe.qos).'));

s = m.section(form.NamedSection, 'global', 'global', _('Global'));

o = s.option(form.Flag, 'enabled', _('Enable marking rules'),
_('Turns the rules below off without deleting them. The DSCP maps and the small-packet ' +
'priority stay in effect either way.'));
o.default = '1';
o.rmempty = false;

o = s.option(form.Value, 'small_packet_len', _('Small packet: maximum L3 length'),
_('Frames up to this IP length take the priority below whatever their marking: ' +
'ACKs, handshakes, DNS, VoIP and game traffic jump the bulk queue. 0 disables. ' +
'A value just under the MTU means "everything that is not a full-size bulk frame".'));
o.datatype = 'and(uinteger,range(0,1500))';
o.placeholder = '128';

o = s.option(form.ListValue, 'small_packet_prio', _('Small packet: priority'));
prio_options(o);
o.default = '5';
Comment on lines +51 to +52

@openwrt-ai openwrt-ai Aug 23, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Selecting Priority 5 here deletes small_packet_prio from UCI rather than writing it: form.js:2152 removes an option when fval == this.default and rmempty is still at its default of true. So the device then runs on whatever ppe-qos compiles in as its own default, while the page keeps showing 5.

That is only harmless if the backend default is also 5. Every other option that carries a meaningful value is pinned — the enabled flag right above on line 41 has the same default = '1' plus an explicit o.rmempty = false, and class, dscp and prio all set it too. small_packet_prio is the one option with a default that is not pinned; is that deliberate, or should it get o.rmempty = false like its neighbour?

Generated by Claude Code


o = s.option(form.Value, 'wan_port', _('Uplink switch port'),
_('Left empty this is taken from the WAN interface, with any VLAN id stripped, ' +
'since the switch knows only the port. Set it if that guess is wrong.'));
o.datatype = 'netdevname';
o.placeholder = _('auto');
o.optional = true;
Comment on lines +58 to +59

@openwrt-ai openwrt-ai Aug 23, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wan_port is the only option on the page with no datatype, so it accepts arbitrary free text — spaces, ;, $(...) — which is then written to UCI and consumed by the ppe-qos shell/init code that runs dcb app dev <port>. Since the description says the value is derived from the WAN interface's device with the VLAN id stripped, netdevname is the matching validator (1–15 chars, no :, /, % or whitespace):

Suggested change
o.placeholder = _('auto');
o.optional = true;
o.placeholder = _('auto');
o.datatype = 'netdevname';
o.optional = true;

If the backend actually expects a numeric switch port index rather than a device name, use uinteger instead — but it should not stay unvalidated either way.

Generated by Claude Code


/* Marking rules. */
s = m.section(form.GridSection, 'rule', _('Marking rules'),
_('Each rule is applied in both directions: as written on the ports your clients sit ' +
'behind, and mirrored on the uplink port so the returning half of the same connection ' +
'is marked too. Ports may be single or a range (5000-5500), and several may be listed. ' +
'The switch matches addresses and ports only - there is no matching by domain name.'));
s.addremove = true;
s.anonymous = true;
s.sortable = true;
s.nodescriptions = true;

o = s.option(form.Flag, 'enabled', _('Enable'));
o.editable = true;
o.default = '1';

o = s.option(form.Value, 'name', _('Name'));
o.rmempty = false;

o = s.option(form.ListValue, 'proto', _('Protocol'));
o.value('tcpudp', _('TCP and UDP'));
o.value('tcp', 'TCP');
o.value('udp', 'UDP');
o.default = 'tcpudp';

o = s.option(form.Value, 'src_ip', _('Source address'),
_('Optional. Addresses or CIDRs, space separated; IPv4 and IPv6 may be mixed.'));
o.datatype = 'list(ipmask)';
o.optional = true;
o.modalonly = true;

o = s.option(form.Value, 'dest_ip', _('Destination address'),
_('Optional, same syntax as the source address.'));
o.datatype = 'list(ipmask)';
o.optional = true;
o.modalonly = true;

o = s.option(form.Value, 'src_port', _('Source port'),
_('Optional. A port, a range, or several separated by spaces.'));
o.datatype = 'list(portrange)';
o.optional = true;
o.modalonly = true;

o = s.option(form.Value, 'dest_port', _('Destination port'),
_('Optional, same syntax as the source port. This is the usual way to name a service.'));
o.datatype = 'list(portrange)';
o.optional = true;

o = s.option(form.ListValue, 'class', _('Class'),
_('A class only changes the queue if the map below turns it into a priority of 4 or more. ' +
'It also reaches Wi-Fi, which reads the DSCP for its own access categories.'));
CLASSES.forEach(function(c) { o.value(c[0], c[1]); });
o.rmempty = false;

/* DSCP to priority. */
s = m.section(form.GridSection, 'dscp', _('DSCP to priority'),
_('What a mark is worth once the switch reads it. Applied with dcb app on every switch ' +
'port, so it classifies traffic marked by these rules and traffic that arrives already ' +
'marked alike. Anything unlisted stays at priority 0 and rides the bulk queue.'));
s.addremove = true;
s.anonymous = true;

o = s.option(form.Value, 'dscp', _('DSCP'));
o.datatype = 'and(uinteger,range(0,63))';
o.rmempty = false;
o.value('32', _('32 (CS4 - games)'));
o.value('34', _('34 (AF41 - calls)'));
o.value('40', _('40 (CS5 - signalling, DNS)'));
o.value('46', _('46 (EF - voice)'));
o.value('48', _('48 (CS6 - control)'));
Comment on lines +125 to +129

@openwrt-ai openwrt-ai Aug 23, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: AF31 is offered as a marking class (CLASSES, line 9) but DSCP 26 is missing from these suggestions, so a user who marks a flow "multimedia streaming" finds nothing to select here and has to know that AF31 means 26 and type it. The other three unlisted classes are self-explanatory — CS0/CS1/CS3 are exactly the ones the section text means by "anything unlisted stays at priority 0" — which makes AF31 look like an oversight rather than the same policy.

The field is a form.Value with choices, so typing 26 does work; this is only about the suggestion list matching the classes the page itself offers:

Suggested change
o.value('32', _('32 (CS4 - games)'));
o.value('34', _('34 (AF41 - calls)'));
o.value('40', _('40 (CS5 - signalling, DNS)'));
o.value('46', _('46 (EF - voice)'));
o.value('48', _('48 (CS6 - control)'));
o.value('26', _('26 (AF31 - streaming)'));
o.value('32', _('32 (CS4 - games)'));
o.value('34', _('34 (AF41 - calls)'));
o.value('40', _('40 (CS5 - signalling, DNS)'));
o.value('46', _('46 (EF - voice)'));
o.value('48', _('48 (CS6 - control)'));

Generated by Claude Code


o = s.option(form.ListValue, 'prio', _('Priority'));
prio_options(o);
o.rmempty = false;

return m.render();
}
});
14 changes: 14 additions & 0 deletions applications/luci-app-ppe-qos/root/usr/share/luci/menu.d/luci-app-ppe-qos.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"admin/network/ppe-qos": {
"title": "PPE QoS",
"order": 61,
"action": {
"type": "view",
"path": "network/ppe-qos"
},
"depends": {
"acl": [ "luci-app-ppe-qos" ],
"uci": { "ppe-qos": true }
}
}
}
11 changes: 11 additions & 0 deletions applications/luci-app-ppe-qos/root/usr/share/rpcd/acl.d/luci-app-ppe-qos.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"luci-app-ppe-qos": {
"description": "Grant access to the PPE hardware QoS configuration",
"read": {
"uci": [ "ppe-qos" ]
},
"write": {
"uci": [ "ppe-qos" ]
}
}
}