67d02a45eb
Most tools used for compliance and SBOM generation use SPDX identifiers This change brings us a step closer to an easy SBOM generation. Signed-off-by: Alin Jerpelea <alin.jerpelea@sony.com>
540 lines
17 KiB
C
540 lines
17 KiB
C
/****************************************************************************
|
|
* net/ieee802154/ieee802154_sockif.c
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership. The
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <sys/types.h>
|
|
#include <sys/socket.h>
|
|
#include <stdbool.h>
|
|
#include <string.h>
|
|
#include <assert.h>
|
|
#include <errno.h>
|
|
#include <debug.h>
|
|
|
|
#include <socket/socket.h>
|
|
#include <netpacket/ieee802154.h>
|
|
|
|
#include <nuttx/net/net.h>
|
|
#include <nuttx/net/radiodev.h>
|
|
|
|
#include "ieee802154/ieee802154.h"
|
|
|
|
#ifdef CONFIG_NET_IEEE802154
|
|
|
|
/****************************************************************************
|
|
* Private Function Prototypes
|
|
****************************************************************************/
|
|
|
|
static int ieee802154_setup(FAR struct socket *psock);
|
|
static sockcaps_t ieee802154_sockcaps(FAR struct socket *psock);
|
|
static void ieee802154_addref(FAR struct socket *psock);
|
|
static int ieee802154_bind(FAR struct socket *psock,
|
|
FAR const struct sockaddr *addr, socklen_t addrlen);
|
|
static int ieee802154_getsockname(FAR struct socket *psock,
|
|
FAR struct sockaddr *addr, FAR socklen_t *addrlen);
|
|
static int ieee802154_getpeername(FAR struct socket *psock,
|
|
FAR struct sockaddr *addr, FAR socklen_t *addrlen);
|
|
static int ieee802154_connect(FAR struct socket *psock,
|
|
FAR const struct sockaddr *addr, socklen_t addrlen);
|
|
static int ieee802154_close(FAR struct socket *psock);
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
const struct sock_intf_s g_ieee802154_sockif =
|
|
{
|
|
ieee802154_setup, /* si_setup */
|
|
ieee802154_sockcaps, /* si_sockcaps */
|
|
ieee802154_addref, /* si_addref */
|
|
ieee802154_bind, /* si_bind */
|
|
ieee802154_getsockname, /* si_getsockname */
|
|
ieee802154_getpeername, /* si_getpeername */
|
|
NULL, /* si_listen */
|
|
ieee802154_connect, /* si_connect */
|
|
NULL, /* si_accept */
|
|
NULL, /* si_poll */
|
|
ieee802154_sendmsg, /* si_sendmsg */
|
|
ieee802154_recvmsg, /* si_recvmsg */
|
|
ieee802154_close /* si_close */
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Private Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: ieee802154_sockif_alloc
|
|
*
|
|
* Description:
|
|
* Allocate and attach a PF_IEEE802154 connection structure.
|
|
*
|
|
* Assumptions:
|
|
* The network is locked
|
|
*
|
|
****************************************************************************/
|
|
|
|
static int ieee802154_sockif_alloc(FAR struct socket *psock)
|
|
{
|
|
/* Allocate the packet socket connection structure and save in the new
|
|
* socket instance.
|
|
*/
|
|
|
|
FAR struct ieee802154_conn_s *conn = ieee802154_conn_alloc();
|
|
if (conn == NULL)
|
|
{
|
|
/* Failed to reserve a connection structure */
|
|
|
|
return -ENOMEM;
|
|
}
|
|
|
|
/* Set the reference count on the connection structure. This reference
|
|
* count will be incremented only if the socket is dup'ed
|
|
*/
|
|
|
|
DEBUGASSERT(conn->crefs == 0);
|
|
conn->crefs = 1;
|
|
|
|
/* Save the pre-allocated connection in the socket structure */
|
|
|
|
psock->s_conn = conn;
|
|
return OK;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: ieee802154_setup
|
|
*
|
|
* Description:
|
|
* Called for socket() to verify that the provided socket type and
|
|
* protocol are usable by this address family. Perform any family-
|
|
* specific socket fields.
|
|
*
|
|
* Input Parameters:
|
|
* psock A pointer to a user allocated socket structure to be
|
|
* initialized.
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) is returned on success. Otherwise, a negated errno value is
|
|
* returned.
|
|
*
|
|
****************************************************************************/
|
|
|
|
static int ieee802154_setup(FAR struct socket *psock)
|
|
{
|
|
/* Allocate the appropriate connection structure. This reserves the
|
|
* connection structure, it is unallocated at this point. It will not
|
|
* actually be initialized until the socket is connected.
|
|
*
|
|
* SOCK_DGRAM and SOCK_CTRL are supported
|
|
* (since the MAC header is stripped)
|
|
*/
|
|
|
|
if (psock->s_type == SOCK_DGRAM || psock->s_type == SOCK_CTRL)
|
|
{
|
|
return ieee802154_sockif_alloc(psock);
|
|
}
|
|
else
|
|
{
|
|
return -EPROTONOSUPPORT;
|
|
}
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: ieee802154_sockcaps
|
|
*
|
|
* Description:
|
|
* Return the bit encoded capabilities of this socket.
|
|
*
|
|
* Input Parameters:
|
|
* psock - Socket structure of the socket whose capabilities are being
|
|
* queried.
|
|
*
|
|
* Returned Value:
|
|
* The set of socket cababilities is returned.
|
|
*
|
|
****************************************************************************/
|
|
|
|
static sockcaps_t ieee802154_sockcaps(FAR struct socket *psock)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: ieee802154_addref
|
|
*
|
|
* Description:
|
|
* Increment the reference count on the underlying connection structure.
|
|
*
|
|
* Input Parameters:
|
|
* psock - Socket structure of the socket whose reference count will be
|
|
* incremented.
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
static void ieee802154_addref(FAR struct socket *psock)
|
|
{
|
|
FAR struct ieee802154_conn_s *conn;
|
|
|
|
DEBUGASSERT(psock->s_type == SOCK_DGRAM || psock->s_type == SOCK_CTRL);
|
|
|
|
conn = psock->s_conn;
|
|
DEBUGASSERT(conn->crefs > 0 && conn->crefs < 255);
|
|
conn->crefs++;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: ieee802154_connect
|
|
*
|
|
* Description:
|
|
* ieee802154_connect() connects the local socket referred to by the
|
|
* structure 'psock' to the address specified by 'addr'. The addrlen
|
|
* argument specifies the size of 'addr'. The format of the address in
|
|
* 'addr' is determined by the address space of the socket 'psock'.
|
|
*
|
|
* If the socket 'psock' is of type SOCK_DGRAM then 'addr' is the address
|
|
* to which datagrams are sent by default, and the only address from which
|
|
* datagrams are received. If the socket is of type SOCK_STREAM or
|
|
* SOCK_SEQPACKET, this call attempts to make a connection to the socket
|
|
* that is bound to the address specified by 'addr'.
|
|
*
|
|
* Generally, connection-based protocol sockets may successfully
|
|
* ieee802154_connect() only once; connectionless protocol sockets may use
|
|
* ieee802154_connect() multiple times to change their association.
|
|
* Connectionless sockets may dissolve the association by connecting to
|
|
* an address with the sa_family member of sockaddr set to AF_UNSPEC.
|
|
*
|
|
* Input Parameters:
|
|
* psock Pointer to a socket structure initialized by psock_socket()
|
|
* addr Server address (form depends on type of socket)
|
|
* addrlen Length of actual 'addr'
|
|
*
|
|
* Returned Value:
|
|
* 0 on success; a negated errno value on failure. See connect() for the
|
|
* list of appropriate errno values to be returned.
|
|
*
|
|
****************************************************************************/
|
|
|
|
static int ieee802154_connect(FAR struct socket *psock,
|
|
FAR const struct sockaddr *addr,
|
|
socklen_t addrlen)
|
|
{
|
|
FAR struct ieee802154_conn_s *conn;
|
|
FAR struct sockaddr_ieee802154_s *ieeeaddr;
|
|
int ret = OK;
|
|
|
|
conn = psock->s_conn;
|
|
|
|
/* Verify the address family */
|
|
|
|
if (addr->sa_family == AF_IEEE802154)
|
|
{
|
|
/* Save the "connection" address */
|
|
|
|
ieeeaddr = (FAR struct sockaddr_ieee802154_s *)addr;
|
|
memcpy(&conn->raddr, &ieeeaddr->sa_addr,
|
|
sizeof(struct ieee802154_saddr_s));
|
|
}
|
|
else
|
|
{
|
|
/* The specified address is not a valid address for the address family
|
|
* of the specified socket.
|
|
*/
|
|
|
|
ret = -EAFNOSUPPORT;
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: ieee802154_bind
|
|
*
|
|
* Description:
|
|
* ieee802154_bind() gives the socket 'psock' the local address 'addr'.
|
|
* 'addr' is 'addrlen' bytes long. Traditionally, this is called
|
|
* "assigning a name to a socket." When a socket is created with
|
|
* socket(), it exists in a name space (address family) but has no name
|
|
* assigned.
|
|
*
|
|
* Input Parameters:
|
|
* psock Socket structure of the socket to bind
|
|
* addr Socket local address
|
|
* addrlen Length of 'addr'
|
|
*
|
|
* Returned Value:
|
|
* 0 on success; A negated errno value is returned on failure. See
|
|
* bind() for a list a appropriate error values.
|
|
*
|
|
****************************************************************************/
|
|
|
|
static int ieee802154_bind(FAR struct socket *psock,
|
|
FAR const struct sockaddr *addr,
|
|
socklen_t addrlen)
|
|
{
|
|
FAR const struct sockaddr_ieee802154_s *iaddr;
|
|
FAR struct ieee802154_conn_s *conn;
|
|
FAR struct radio_driver_s *radio;
|
|
|
|
/* Verify that a valid address has been provided */
|
|
|
|
if (addr->sa_family != AF_IEEE802154 ||
|
|
addrlen < sizeof(struct sockaddr_ieee802154_s))
|
|
{
|
|
nerr("ERROR: Invalid family: %u or address length: %zu < %zu\n",
|
|
addr->sa_family, (size_t)addrlen,
|
|
sizeof(struct sockaddr_ieee802154_s));
|
|
return -EBADF;
|
|
}
|
|
|
|
conn = psock->s_conn;
|
|
|
|
/* Bind a PF_IEEE802154 socket to an network device. */
|
|
|
|
if (conn == NULL ||
|
|
(psock->s_type != SOCK_DGRAM && psock->s_type != SOCK_CTRL))
|
|
{
|
|
nerr("ERROR: Invalid socket type: %u\n", psock->s_type);
|
|
return -EBADF;
|
|
}
|
|
|
|
/* Verify that the socket is not already bound. */
|
|
|
|
if (_SS_ISBOUND(conn->sconn.s_flags))
|
|
{
|
|
nerr("ERROR: Already bound\n");
|
|
return -EINVAL;
|
|
}
|
|
|
|
iaddr = (FAR const struct sockaddr_ieee802154_s *)addr;
|
|
|
|
/* Very that some address was provided.
|
|
*
|
|
* REVISIT: Currently and explicit address must be assigned. Should we
|
|
* support some moral equivalent to INADDR_ANY?
|
|
*/
|
|
|
|
if (iaddr->sa_addr.s_mode == IEEE802154_ADDRMODE_NONE)
|
|
{
|
|
nerr("ERROR: No address provided\n");
|
|
return -EADDRNOTAVAIL;
|
|
}
|
|
|
|
/* Find the device associated with the requested address */
|
|
|
|
radio = ieee802154_find_device(conn, &iaddr->sa_addr);
|
|
if (radio == NULL)
|
|
{
|
|
nerr("ERROR: No radio at this address\n");
|
|
return -ENODEV;
|
|
}
|
|
|
|
/* Save the address as the socket's local address */
|
|
|
|
memcpy(&conn->laddr, &iaddr->sa_addr, sizeof(struct ieee802154_saddr_s));
|
|
|
|
return OK;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: ieee802154_getsockname
|
|
*
|
|
* Description:
|
|
* The ieee802154_getsockname() function retrieves the locally-bound name
|
|
* of the specified packet socket, stores this address in the sockaddr
|
|
* structure pointed to by the 'addr' argument, and stores the length of
|
|
* this address in the object pointed to by the 'addrlen' argument.
|
|
*
|
|
* If the actual length of the address is greater than the length of the
|
|
* supplied sockaddr structure, the stored address will be truncated.
|
|
*
|
|
* If the socket has not been bound to a local name, the value stored in
|
|
* the object pointed to by address is unspecified.
|
|
*
|
|
* Input Parameters:
|
|
* psock Socket structure of the socket to be queried
|
|
* addr sockaddr structure to receive data [out]
|
|
* addrlen Length of sockaddr structure [in/out]
|
|
*
|
|
* Returned Value:
|
|
* On success, 0 is returned, the 'addr' argument points to the address
|
|
* of the socket, and the 'addrlen' argument points to the length of the
|
|
* address. Otherwise, a negated errno value is returned. See
|
|
* getsockname() for the list of appropriate error numbers.
|
|
*
|
|
****************************************************************************/
|
|
|
|
static int ieee802154_getsockname(FAR struct socket *psock,
|
|
FAR struct sockaddr *addr, FAR
|
|
socklen_t *addrlen)
|
|
{
|
|
FAR struct ieee802154_conn_s *conn;
|
|
FAR struct sockaddr_ieee802154_s tmp;
|
|
socklen_t copylen;
|
|
|
|
conn = psock->s_conn;
|
|
|
|
/* Create a copy of the full address on the stack */
|
|
|
|
tmp.sa_family = AF_IEEE802154;
|
|
memcpy(&tmp.sa_addr, &conn->laddr, sizeof(struct ieee802154_saddr_s));
|
|
|
|
/* Copy to the user buffer, truncating if necessary */
|
|
|
|
copylen = sizeof(struct sockaddr_ieee802154_s);
|
|
if (copylen > *addrlen)
|
|
{
|
|
copylen = *addrlen;
|
|
}
|
|
|
|
memcpy(addr, &tmp, copylen);
|
|
|
|
/* Return the actual size transferred */
|
|
|
|
*addrlen = copylen;
|
|
return OK;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: ieee802154_getpeername
|
|
*
|
|
* Description:
|
|
* The ieee802154_getpeername() function retrieves the remote-connectd name
|
|
* of the specified packet socket, stores this address in the sockaddr
|
|
* structure pointed to by the 'addr' argument, and stores the length of
|
|
* this address in the object pointed to by the 'addrlen' argument.
|
|
*
|
|
* If the actual length of the address is greater than the length of the
|
|
* supplied sockaddr structure, the stored address will be truncated.
|
|
*
|
|
* If the socket has not been bound to a local name, the value stored in
|
|
* the object pointed to by address is unspecified.
|
|
*
|
|
* Parameters:
|
|
* psock Socket structure of the socket to be queried
|
|
* addr sockaddr structure to receive data [out]
|
|
* addrlen Length of sockaddr structure [in/out]
|
|
*
|
|
* Returned Value:
|
|
* On success, 0 is returned, the 'addr' argument points to the address
|
|
* of the socket, and the 'addrlen' argument points to the length of the
|
|
* address. Otherwise, a negated errno value is returned. See
|
|
* getpeername() for the list of appropriate error numbers.
|
|
*
|
|
****************************************************************************/
|
|
|
|
static int ieee802154_getpeername(FAR struct socket *psock,
|
|
FAR struct sockaddr *addr, FAR
|
|
socklen_t *addrlen)
|
|
{
|
|
FAR struct ieee802154_conn_s *conn;
|
|
FAR struct sockaddr_ieee802154_s tmp;
|
|
socklen_t copylen;
|
|
|
|
conn = psock->s_conn;
|
|
|
|
/* Create a copy of the full address on the stack */
|
|
|
|
tmp.sa_family = PF_IEEE802154;
|
|
memcpy(&tmp.sa_addr, &conn->raddr, sizeof(struct ieee802154_saddr_s));
|
|
|
|
/* Copy to the user buffer, truncating if necessary */
|
|
|
|
copylen = sizeof(struct sockaddr_ieee802154_s);
|
|
if (copylen > *addrlen)
|
|
{
|
|
copylen = *addrlen;
|
|
}
|
|
|
|
memcpy(addr, &tmp, copylen);
|
|
|
|
/* Return the actual size transferred */
|
|
|
|
*addrlen = copylen;
|
|
return OK;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Name: ieee802154_close
|
|
*
|
|
* Description:
|
|
* Performs the close operation on a PF_IEEE802154 socket instance
|
|
*
|
|
* Input Parameters:
|
|
* psock Socket instance
|
|
*
|
|
* Returned Value:
|
|
* 0 on success; a negated errno value is returned on any failure.
|
|
*
|
|
* Assumptions:
|
|
*
|
|
****************************************************************************/
|
|
|
|
static int ieee802154_close(FAR struct socket *psock)
|
|
{
|
|
/* Perform some pre-close operations for the PF_IEEE802154 address type */
|
|
|
|
switch (psock->s_type)
|
|
{
|
|
case SOCK_DGRAM:
|
|
case SOCK_CTRL:
|
|
{
|
|
FAR struct ieee802154_conn_s *conn = psock->s_conn;
|
|
|
|
/* Is this the last reference to the connection structure (there
|
|
* could be more if the socket was dup'ed).
|
|
*/
|
|
|
|
if (conn->crefs <= 1)
|
|
{
|
|
/* Yes... free the connection structure */
|
|
|
|
conn->crefs = 0; /* No more references on the connection */
|
|
ieee802154_conn_free(psock->s_conn); /* Free network resources */
|
|
}
|
|
else
|
|
{
|
|
/* No.. Just decrement the reference count */
|
|
|
|
conn->crefs--;
|
|
}
|
|
|
|
return OK;
|
|
}
|
|
|
|
default:
|
|
return -EBADF;
|
|
}
|
|
}
|
|
|
|
/****************************************************************************
|
|
* Public Functions
|
|
****************************************************************************/
|
|
|
|
#endif /* CONFIG_NET_IEEE802154 */
|