[PATCH v6 10/14] efi_loader: efi_net: add EFI_IP4_CONFIG2_PROTOCOL
Adriano Córdova
adrianox at gmail.com
Tue Dec 3 20:47:12 CET 2024
El mar, 3 dic 2024 a las 11:05, Ilias Apalodimas (<
ilias.apalodimas at linaro.org>) escribió:
> [...]
>
> > --- /dev/null
> > +++ b/lib/efi_loader/efi_ipconfig.c
> > @@ -0,0 +1,214 @@
> > +// SPDX-License-Identifier: GPL-2.0-or-later
> > +/*
> > + * Implementation of EFI_IP4_CONFIG2_PROTOCOL
> > + *
> > + */
> > +
> > +#include <efi_loader.h>
> > +#include <image.h>
> > +#include <malloc.h>
> > +#include <mapmem.h>
> > +#include <net.h>
> > +
> > +static const efi_guid_t efi_ip4_config2_guid =
> EFI_IP4_CONFIG2_PROTOCOL_GUID;
> > +
> > +struct efi_ip4_config2_manual_address current_http_ip;
> > +static enum efi_ip4_config2_policy current_policy;
> > +static char current_mac_addr[32];
> > +
> > +/* EFI_IP4_CONFIG2_PROTOCOL */
> > +
> > +/*
> > + * efi_ip4_config2_set_data() - Set the configuration for the EFI IPv4
> network
> > + * stack running on the communication device
> > + *
> > + * This function implements EFI_IP4_CONFIG2_PROTOCOL.SetData()
> > + * See the Unified Extensible Firmware Interface
> > + * (UEFI) specification for details.
> > + *
> > + * @this: pointer to the protocol instance
> > + * @data_type: the type of data to set
> > + * @data_size: size of the buffer pointed to by data in bytes
> > + * @data: the data buffer to set
> > + * Return: status code
> > + */
> > +static efi_status_t EFIAPI efi_ip4_config2_set_data(struct
> efi_ip4_config2_protocol *this,
> > + enum
> efi_ip4_config2_data_type data_type,
> > + efi_uintn_t
> data_size,
> > + void *data)
> > +{
> > + EFI_ENTRY("%p, %d, %zu, %p", this, data_type, data_size, data);
> > + efi_status_t ret = EFI_SUCCESS;
> > +
> > + if (!this || (data && !data_size) || (!data && data_size))
> > + return EFI_EXIT(EFI_INVALID_PARAMETER);
> > +
> > + switch (data_type) {
> > + case EFI_IP4_CONFIG2_DATA_TYPE_INTERFACEINFO:
> > + return EFI_EXIT(EFI_WRITE_PROTECTED);
> > + case EFI_IP4_CONFIG2_DATA_TYPE_MANUAL_ADDRESS:
> > + if (current_policy != EFI_IP4_CONFIG2_POLICY_STATIC)
> > + return EFI_EXIT(EFI_WRITE_PROTECTED);
> > + if (data_size == 0 && !data) {
>
> we usually do if (!data_size && ...)
>
> > + memset((void *)¤t_http_ip, 0,
> > + sizeof(current_http_ip));
> > + return EFI_EXIT(EFI_SUCCESS);
> > + }
> > + if (data && data_size == sizeof(struct
> efi_ip4_config2_manual_address)) {
> > + memcpy((void *)¤t_http_ip, data,
> > + sizeof(struct
> efi_ip4_config2_manual_address));
> > + efi_net_set_addr(¤t_http_ip.address,
> > + ¤t_http_ip.subnet_mask,
> NULL);
> > + return EFI_EXIT(EFI_SUCCESS);
> > + }
> > + return EFI_EXIT(EFI_INVALID_PARAMETER);
> > + case EFI_IP4_CONFIG2_DATA_TYPE_POLICY:
> > + if (data && data_size == sizeof(enum
> efi_ip4_config2_policy)) {
> > + current_policy = *(enum
> efi_ip4_config2_policy *)data;
> > + return EFI_EXIT(EFI_SUCCESS);
> > + }
>
> The spec is a bit cryptic here, but it says
>
> EFI_INVALID_PARAMETER
> One or more of the following are TRUE:
> - This is NULL.
> - One or more fields in Data and DataSize do not match the requirement
> of the data type indicated by DataType
>
> and
>
> EFI_BAD_BUFFER_SIZE
> - The DataSize does not match the size of the type indicated by DataType
>
> I think we should return EFI_BAD_BUFFER_SIZE on both of the checks above.
>
> Heinrich any idea?
>
> > + return EFI_EXIT(EFI_INVALID_PARAMETER);
> > +
> > + default:
> > + return EFI_EXIT(EFI_UNSUPPORTED);
> > + }
> > +
> > + return EFI_EXIT(ret);
> > +}
> > +
> > +/*
> > + * efi_ip4_config2_get_data() - Get the configuration for the EFI IPv4
> network
> > + * stack running on the communication device
> > + *
> > + * This function implements EFI_IP4_CONFIG2_PROTOCOL.GetData()
> > + * See the Unified Extensible Firmware Interface
> > + * (UEFI) specification for details.
> > + *
> > + * @this: pointer to the protocol instance
> > + * @data_type: the type of data to get
> > + * @data_size: size
> > + * @data: the data buffer
> > + * Return: status code
> > + */
> > +static efi_status_t EFIAPI efi_ip4_config2_get_data(struct
> efi_ip4_config2_protocol *this,
> > + enum
> efi_ip4_config2_data_type data_type,
> > + efi_uintn_t
> *data_size,
> > + void *data)
> > +{
> > + EFI_ENTRY("%p, %d, %p, %p", this, data_type, data_size, data);
> > +
> > + efi_status_t ret = EFI_SUCCESS;
> > + struct efi_ip4_config2_interface_info *info;
> > + int tmp;
> > +
> > + if (!this || !data_size)
> > + return EFI_EXIT(EFI_INVALID_PARAMETER);
> > +
> > + if (*data_size && !data)
> > + return EFI_EXIT(EFI_INVALID_PARAMETER);
> > +
> > + tmp = sizeof(struct efi_ip4_config2_interface_info) +
> sizeof(struct efi_ip4_route_table);
> > +
> > + switch (data_type) {
> > + case EFI_IP4_CONFIG2_DATA_TYPE_INTERFACEINFO:
> > + if (*data_size < tmp) {
> > + *data_size = tmp;
> > + return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
> > + }
> > +
> > + info = (struct efi_ip4_config2_interface_info *)data;
> > + memset(info, 0, sizeof(*info));
> > +
> > + info->hw_address_size = 6;
> > + memcpy(info->hw_address.mac_addr, current_mac_addr, 6);
> > + // Set the route table size
> > +
> > + info->route_table_size = 0;
> > + break;
> > + case EFI_IP4_CONFIG2_DATA_TYPE_MANUAL_ADDRESS:
> > + if (*data_size < sizeof(struct
> efi_ip4_config2_manual_address)) {
> > + *data_size = sizeof(struct
> efi_ip4_config2_manual_address);
> > + return EFI_EXIT(EFI_BUFFER_TOO_SMALL);
> > + }
> > +
> > + efi_net_get_addr(¤t_http_ip.address,
> ¤t_http_ip.subnet_mask, NULL);
> > + memcpy(data, (void *)¤t_http_ip,
> > + sizeof(struct efi_ip4_config2_manual_address));
> > +
> > + break;
> > + default:
> > + return EFI_EXIT(EFI_UNSUPPORTED);
>
> The spec doesn't have EFI_UNSUPPORTED for GetData. Instead it says
> EFI_NOT_FOUND "The specified configuration data is not found.". So we
> should return that for every data type that was marked as
> EFI_UNSUPPORTED (I think)
>
> > + }
> > + return EFI_EXIT(ret);
> > +}
> > +
> > +/*
> > + * efi_ip4_config2_register_notify() - Register an event that is to be
> signaled whenever
> > + * a configuration process on the specified configuration
> > + * data is done
> > + *
> > + * This function implements
> EFI_IP4_CONFIG2_PROTOCOL.RegisterDataNotify()
> > + * See the Unified Extensible Firmware Interface
> > + * (UEFI) specification for details.
> > + *
> > + * @this: pointer to the protocol instance
> > + * @data_type: the type of data to register the event for
> > + * @event: the event to register
> > + * Return: status code
> > + */
> > +static efi_status_t EFIAPI efi_ip4_config2_register_notify(struct
> efi_ip4_config2_protocol *this,
> > + enum
> efi_ip4_config2_data_type data_type,
> > + struct
> efi_event *event)
> > +{
> > + EFI_ENTRY("%p, %d, %p", this, data_type, event);
> > +
> > + return EFI_EXIT(EFI_UNSUPPORTED);
> > +}
> > +
> > +/*
> > + * efi_ip4_config2_unregister_notify() - Remove a previously
> registered eventfor
> > + * the specified configuration data
> > + *
> > + * This function implements
> EFI_IP4_CONFIG2_PROTOCOL.UnregisterDataNotify()
> > + * See the Unified Extensible Firmware Interface
> > + * (UEFI) specification for details.
> > + *
> > + * @this: pointer to the protocol instance
> > + * @data_type: the type of data to remove the event for
> > + * @event: the event to unregister
> > + * Return: status code
> > + */
> > +static efi_status_t EFIAPI efi_ip4_config2_unregister_notify(struct
> efi_ip4_config2_protocol *this,
> > + enum
> efi_ip4_config2_data_type data_type,
> > + struct
> efi_event *event)
> > +{
> > + EFI_ENTRY("%p, %d, %p", this, data_type, event);
> > +
> > + return EFI_EXIT(EFI_UNSUPPORTED);
> > +}
> > +
> > +/**
> > + * efi_ipconfig_register() - register the ip4_config2 protocol
> > + *
> > + */
> > +efi_status_t efi_ipconfig_register(const efi_handle_t handle,
> > + struct efi_ip4_config2_protocol
> *ip4config)
> > +{
> > + efi_status_t r = EFI_SUCCESS;
> > +
> > + r = efi_add_protocol(handle, &efi_ip4_config2_guid,
> > + ip4config);
> > + if (r != EFI_SUCCESS) {
> > + log_err("ERROR: Failure to add protocol\n");
> > + return r;
> > + }
> > +
> > + memcpy(current_mac_addr, eth_get_ethaddr(), 6);
>
> You don't need the static variable for this, just copy it on the fly
> when required.
>
> Do you mean calling eth_get_ethaddr() when needed? In that case, this
needs to record the address of the eth
device that was set at this moment. I am not sure, but I think this static
var could be queried in the future from the client
side while another device is set by the u-boot side.
>
> > + ip4config->set_data = efi_ip4_config2_set_data;
> > + ip4config->get_data = efi_ip4_config2_get_data;
> > + ip4config->register_data_notify =
> efi_ip4_config2_register_notify;
> > + ip4config->unregister_data_notify =
> efi_ip4_config2_unregister_notify;
> > +
> > + return EFI_SUCCESS;
> > +}
> > diff --git a/lib/efi_loader/efi_net.c b/lib/efi_loader/efi_net.c
> > index 368f62c5b2..d3a8deecd0 100644
> > --- a/lib/efi_loader/efi_net.c
> > +++ b/lib/efi_loader/efi_net.c
> > @@ -60,11 +60,12 @@ static struct efi_event *wait_for_packet;
> > /**
> > * struct efi_net_obj - EFI object representing a network interface
> > *
> > - * @header: EFI object header
> > - * @net: simple network protocol interface
> > - * @net_mode: status of the network interface
> > - * @pxe: PXE base code protocol interface
> > - * @pxe_mode: status of the PXE base code protocol
> > + * @header: EFI object header
> > + * @net: simple network protocol interface
> > + * @net_mode: status of the network interface
> > + * @pxe: PXE base code protocol interface
> > + * @pxe_mode: status of the PXE base code protocol
> > + * @ip4_config2: IP4 Config2 protocol interface
> > */
> > struct efi_net_obj {
> > struct efi_object header;
> > @@ -72,6 +73,9 @@ struct efi_net_obj {
> > struct efi_simple_network_mode net_mode;
> > struct efi_pxe_base_code_protocol pxe;
> > struct efi_pxe_mode pxe_mode;
> > +#if IS_ENABLED(CONFIG_EFI_IP4_CONFIG2_PROTOCOL)
> > + struct efi_ip4_config2_protocol ip4_config2;
> > +#endif
> > };
> >
> > /*
> > @@ -999,6 +1003,12 @@ efi_status_t efi_net_register(void)
> > return r;
> > }
> >
> > +#ifdef CONFIG_EFI_IP4_CONFIG2_PROTOCOL
>
> #if IS_ENABLED here as well etc
> > + r = efi_ipconfig_register(&netobj->header, &netobj->ip4_config2);
> > + if (r != EFI_SUCCESS)
> > + goto failure_to_add_protocol;
> > +#endif
> > +
> > return EFI_SUCCESS;
> > failure_to_add_protocol:
> > printf("ERROR: Failure to add protocol\n");
> > --
> > 2.43.0
> >
>
> Thanks
> /Ilias
>
More information about the U-Boot
mailing list