milan-avb: milan: adding set/get name command handler

This commit is contained in:
hackerman-kl 2025-12-07 15:18:49 +01:00 committed by Wim Taymans
parent 25a6fdcdb1
commit d9fa0629f6
4 changed files with 205 additions and 0 deletions

View file

@ -738,6 +738,7 @@ if build_module_avb
'module-avb/aecp-aem.c',
'module-avb/aecp-aem-cmds-resps/cmd-lock-entity.c',
'module-avb/aecp-aem-cmds-resps/cmd-available.c',
'module-avb/aecp-aem-cmds-resps/cmd-get-set-name.c',
'module-avb/aecp-aem-cmds-resps/cmd-register-unsolicited-notifications.c',
'module-avb/aecp-aem-cmds-resps/cmd-deregister-unsolicited-notifications.c',
'module-avb/aecp-aem-cmds-resps/reply-unsol-helpers.c',

View file

@ -0,0 +1,184 @@
/* AVB support */
/* SPDX-FileCopyrightText: Copyright © 2025 Alexandre Malki <alexandre.malki@kebag-logic.com> */
/* SPDX-License-Identifier: MIT */
#include <limits.h>
#include <stdbool.h>
#include <inttypes.h>
#include <stdio.h>
#include "../aecp.h"
#include "../aecp-aem.h"
#include "../aecp-aem-state.h"
#include "../aecp-aem-descriptors.h"
#include "cmd-get-set-name.h"
#include "cmd-resp-helpers.h"
#include "reply-unsol-helpers.h"
/**
* \brief Different descriptor hold different position for a name
* Therefore different descriptors should be handled diffierently.
*/
static char *get_name_ptr(uint16_t desc_type, void *ptr, uint16_t name_index)
{
/* Handle Entity specifically due to multiple name fields */
if (desc_type == AVB_AEM_DESC_ENTITY) {
struct avb_aem_desc_entity *d = ptr;
/*
* IEEE 1722.1-2021 Table 7-38:
* 0: entity_name
* 1: group_name
* 2: serial_number
*/
if (name_index == 0) return d->entity_name;
if (name_index == 1) return d->group_name;
if (name_index == 2) return d->serial_number;
return NULL;
}
/* Handle Strings descriptor */
if (desc_type == AVB_AEM_DESC_STRINGS) {
if (name_index > 6)
return NULL;
return (char *)ptr + (name_index * 64);
}
/* Case when the name index should be forcibly 0 */
if (name_index != 0)
return NULL;
/* Exclude descriptors that do not start with object_name */
switch (desc_type) {
case AVB_AEM_DESC_STREAM_PORT_INPUT:
case AVB_AEM_DESC_STREAM_PORT_OUTPUT:
case AVB_AEM_DESC_EXTERNAL_PORT_INPUT:
case AVB_AEM_DESC_EXTERNAL_PORT_OUTPUT:
case AVB_AEM_DESC_INTERNAL_PORT_INPUT:
case AVB_AEM_DESC_INTERNAL_PORT_OUTPUT:
return NULL;
}
/*
* Most others (Configuration, Audio Unit, Stream Input/Output, AVB Interface,
* Clock Source, etc.) start with object_name[64] at offset 0.
*/
return ptr;
}
static int send_unsol_name(struct aecp *aecp,
const struct avb_packet_aecp_aem *p, const void *msg, int len)
{
uint8_t unsol_buf[512];
struct avb_ethernet_header *h_unsol = (void*)unsol_buf;
struct avb_packet_aecp_aem *p_unsol = SPA_PTROFF(h_unsol, sizeof(*h_unsol), void);
struct aecp_aem_base_info info = { 0 };
memcpy(unsol_buf, msg, len);
info.controller_entity_id = htobe64(p->aecp.controller_guid);
info.expire_timeout = INT64_MAX;
return reply_unsolicited_notifications(aecp, &info, unsol_buf, len, false);
}
/**
* IEEE 1722.1-2021 7.4.18 GET_NAME
* For now this is not handling UTF characters, only ASCII
*/
int handle_cmd_get_name_common(struct aecp *aecp, int64_t now,
const void *m, int len)
{
uint8_t buf[512];
struct server *server = aecp->server;
const struct avb_ethernet_header *h = m;
const struct avb_packet_aecp_aem *p = SPA_PTROFF(h, sizeof(*h), void);
const struct avb_packet_aecp_aem_setget_name *cmd;
struct avb_ethernet_header *h_reply;
struct avb_packet_aecp_aem *p_reply;
struct avb_packet_aecp_aem_setget_name *reply;
struct descriptor *desc;
uint16_t desc_type, desc_id, name_index;
char *name_ptr;
cmd = (const struct avb_packet_aecp_aem_setget_name *)p->payload;
desc_type = ntohs(cmd->descriptor_type);
desc_id = ntohs(cmd->descriptor_index);
name_index = ntohs(cmd->name_index);
desc = server_find_descriptor(server, desc_type, desc_id);
if (desc == NULL)
return reply_status(aecp,
AVB_AECP_AEM_STATUS_NO_SUCH_DESCRIPTOR, m, len);
name_ptr = get_name_ptr(desc_type, desc->ptr, name_index);
if (name_ptr == NULL)
return reply_status(aecp,
AVB_AECP_AEM_STATUS_BAD_ARGUMENTS, m, len);
memcpy(buf, m, len);
h_reply = (struct avb_ethernet_header *)buf;
p_reply = SPA_PTROFF(h_reply, sizeof(*h_reply), void);
reply = (struct avb_packet_aecp_aem_setget_name *)p_reply->payload;
/**
* IEEE 1722.1-2021: 7.4.17.1: The name does not contain a trailing NULL
* but if the name is less than 64 bytes in length then it is zero
* padded
*/
memcpy(reply->name, name_ptr, 64);
return reply_success(aecp, buf, len);
}
/**
* IEEE 1722.1-2021 7.4.17 SET_NAME
* For now this is not handling UTF characters, only ASCII
*/
int handle_cmd_set_name_common(struct aecp *aecp, int64_t now,
const void *m, int len)
{
struct server *server = aecp->server;
const struct avb_ethernet_header *h = m;
const struct avb_packet_aecp_aem *p = SPA_PTROFF(h, sizeof(*h), void);
const struct avb_packet_aecp_aem_setget_name *cmd;
struct descriptor *desc;
uint16_t desc_type, desc_id, name_index;
char *name_ptr;
int rc;
cmd = (const struct avb_packet_aecp_aem_setget_name *)p->payload;
desc_type = ntohs(cmd->descriptor_type);
desc_id = ntohs(cmd->descriptor_index);
name_index = ntohs(cmd->name_index);
desc = server_find_descriptor(server, desc_type, desc_id);
if (desc == NULL)
return reply_status(aecp,
AVB_AECP_AEM_STATUS_NO_SUCH_DESCRIPTOR, m, len);
name_ptr = get_name_ptr(desc_type, desc->ptr, name_index);
if (name_ptr == NULL)
return reply_status(aecp,
AVB_AECP_AEM_STATUS_BAD_ARGUMENTS, m, len);
/**
* IEEE 1722.1-2021: 7.4.17.1: The name does not contain a trailing NULL
* but if the name is less than 64 bytes in length then it is zero
* padded
*/
memcpy(name_ptr, cmd->name, 64);
/** TODO: According to the specification, the string should alwasy be 0
* terminated, the goal would be to check whether a string is UTF-8 and
* that it is correctly zero terminitaed if less than 64 char, if not
* then a simple memcpy is enough */
rc = reply_success(aecp, m, len);
if (rc < 0)
return rc;
return send_unsol_name(aecp, p, m, len);
}

View file

@ -0,0 +1,13 @@
/* AVB support */
/* SPDX-FileCopyrightText: Copyright © 2025 Kebag-Logic */
/* SPDX-License-Identifier: MIT */
#ifndef __AVB_AECP_AEM_CMD_GET_SET_NAME_H__
#define __AVB_AECP_AEM_CMD_GET_SET_NAME_H__
#include "../aecp.h"
int handle_cmd_set_name_common(struct aecp *aecp, int64_t now, const void *m, int len);
int handle_cmd_get_name_common(struct aecp *aecp, int64_t now, const void *m, int len);
#endif /* __AVB_AECP_AEM_CMD_GET_SET_NAME_H__ */

View file

@ -13,6 +13,7 @@
#include "aecp-aem-cmds-resps/cmd-lock-entity.h"
#include "aecp-aem-cmds-resps/cmd-register-unsolicited-notifications.h"
#include "aecp-aem-cmds-resps/cmd-deregister-unsolicited-notifications.h"
#include "aecp-aem-cmds-resps/cmd-get-set-name.h"
/* ACQUIRE_ENTITY */
@ -303,6 +304,12 @@ static const struct cmd_info cmd_info_milan_v12[] = {
AECP_AEM_HANDLE_CMD(AVB_AECP_AEM_CMD_GET_AVB_INFO, true,
handle_get_avb_info_common),
AECP_AEM_HANDLE_CMD(AVB_AECP_AEM_CMD_SET_NAME, false,
handle_cmd_set_name_common),
AECP_AEM_HANDLE_CMD(AVB_AECP_AEM_CMD_GET_NAME, true,
handle_cmd_get_name_common),
};
static const struct {