/**************************************************************************** * net/can/can_getsockopt.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 #include #include #include #include #include #include #include #include "socket/socket.h" #include "utils/utils.h" #include "can/can.h" #ifdef CONFIG_NET_CANPROTO_OPTIONS /**************************************************************************** * Public Functions ****************************************************************************/ /**************************************************************************** * Name: can_getsockopt * * Description: * can_getsockopt() retrieves the value for the option specified by the * 'option' argument for the socket specified by the 'psock' argument. If * the size of the option value is greater than 'value_len', the value * stored in the object pointed to by the 'value' argument will be silently * truncated. Otherwise, the length pointed to by the 'value_len' argument * will be modified to indicate the actual length of the 'value'. * * See a complete list of values for the socket-level * 'option' argument. Protocol-specific options are are protocol specific * header files (such as nuttx/can.h for the case of the CAN protocol). * * Input Parameters: * psock Socket structure of the socket to query * level Protocol level to set the option * option identifies the option to get * value Points to the argument value * value_len The length of the argument value * * Returned Value: * Returns zero (OK) on success. On failure, it returns a negated errno * value to indicate the nature of the error. See psock_getsockopt() for * the complete list of appropriate return error codes. * ****************************************************************************/ int can_getsockopt(FAR struct socket *psock, int level, int option, FAR void *value, FAR socklen_t *value_len) { FAR struct can_conn_s *conn; int ret = OK; DEBUGASSERT(value != NULL && value_len != NULL); conn = psock->s_conn; if (level != SOL_CAN_RAW) { return -ENOPROTOOPT; } if (psock->s_type != SOCK_RAW) { nerr("ERROR: Not a RAW CAN socket\n"); return -ENOTCONN; } switch (option) { case CAN_RAW_FILTER: if (*value_len % sizeof(struct can_filter) != 0) { ret = -EINVAL; } else if (*value_len > CONFIG_NET_CAN_RAW_FILTER_MAX * sizeof(struct can_filter)) { ret = -EINVAL; } else { int count = conn->filter_count; int i; if (*value_len < count * sizeof(struct can_filter)) { count = *value_len / sizeof(struct can_filter); } else { *value_len = count * sizeof(struct can_filter); } for (i = 0; i < count; i++) { ((FAR struct can_filter *)value)[i] = conn->filters[i]; } } break; #ifdef CONFIG_NET_CAN_ERRORS case CAN_RAW_ERR_FILTER: if (*value_len < sizeof(can_err_mask_t)) { return -EINVAL; } else { FAR can_err_mask_t *mask = (FAR can_err_mask_t *)value; *mask = conn->err_mask; *value_len = sizeof(can_err_mask_t); } break; #endif case CAN_RAW_LOOPBACK: case CAN_RAW_RECV_OWN_MSGS: #ifdef CONFIG_NET_CAN_CANFD case CAN_RAW_FD_FRAMES: #endif #ifdef CONFIG_NET_CAN_RAW_TX_DEADLINE case CAN_RAW_TX_DEADLINE: #endif /* Verify that option is the size of an 'int'. Should also check * that 'value' is properly aligned for an 'int' */ if (*value_len < sizeof(int)) { return -EINVAL; } /* Sample the current options. This is atomic operation and so * should not require any special steps for thread safety. We * this outside of the macro because you can never be sure what * a macro will do. */ *(FAR int *)value = _SO_GETOPT(conn->sconn.s_options, option); *value_len = sizeof(int); break; #if CONFIG_NET_RECV_BUFSIZE > 0 case SO_RCVBUF: /* Verify that option is the size of an 'int'. Should also check * that 'value' is properly aligned for an 'int' */ if (*value_len != sizeof(int)) { return -EINVAL; } *(FAR int *)value = conn->recv_buffnum * CONFIG_IOB_BUFSIZE; break; #endif default: nerr("ERROR: Unrecognized RAW CAN socket option: %d\n", option); ret = -ENOPROTOOPT; break; } return ret; } #endif /* CONFIG_NET_CANPROTO_OPTIONS */