posix: deprecate CONFIG_POSIX_API

This change deprecates the Kconfig option `CONFIG_POSIX_API`.

It is slated for removal in Zephyr v4.5.0.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>

Author: cfriedt

doc/services/portability/posix/kconfig/index.rst

@@ -19,7 +19,7 @@ implementation of the POSIX API.
 * :kconfig:option:`CONFIG_NET_SOCKETS`
 * :kconfig:option:`CONFIG_ZVFS_POLL_MAX`
 * :kconfig:option:`CONFIG_ZVFS_OPEN_MAX`
-* :kconfig:option:`CONFIG_POSIX_API`
+* :kconfig:option:`CONFIG_POSIX_SYSTEM_INTERFACES`
 * :kconfig:option:`CONFIG_POSIX_OPEN_MAX`
 * :kconfig:option:`CONFIG_POSIX_PTHREAD_ATTR_GUARDSIZE_BITS`
 * :kconfig:option:`CONFIG_POSIX_PTHREAD_ATTR_GUARDSIZE_DEFAULT`

doc/services/portability/posix/overview/index.rst

@@ -85,10 +85,10 @@ leverages the ``nanosleep()`` and ``perror()`` POSIX functions.
 .. code-block:: cfg
    :caption: `prj.conf` for a simple POSIX app in Zephyr
 
-    CONFIG_POSIX_API=y
+    CONFIG_POSIX_AEP_REALTIME_MINIMAL=y
 
 .. code-block:: c
-   :caption: A simple app that uses Zephyr's POSIX API
+   :caption: A simple app that uses the POSIX API
 
     #include <stddef.h>
     #include <stdio.h>
@@ -128,38 +128,30 @@ explicitly choose to enable POSIX options via :ref:`Kconfig<kconfig>` selection.
 Subprofiles
 +++++++++++
 
-Enable one of the Kconfig options below to quickly configure a pre-defined
+Applications should enable one of the Kconfig options below to quickly configure a pre-defined
 :ref:`POSIX subprofile <posix_subprofiles>`.
 
 * :kconfig:option:`CONFIG_POSIX_AEP_CHOICE_BASE` (:ref:`Base <posix_system_interfaces_required>`)
 * :kconfig:option:`CONFIG_POSIX_AEP_CHOICE_PSE51` (:ref:`PSE51 <posix_aep_pse51>`)
 * :kconfig:option:`CONFIG_POSIX_AEP_CHOICE_PSE52` (:ref:`PSE52 <posix_aep_pse52>`)
 * :kconfig:option:`CONFIG_POSIX_AEP_CHOICE_PSE53` (:ref:`PSE53 <posix_aep_pse53>`)
 
-Additional POSIX :ref:`Options and Option Groups <posix_option_groups>` may be enabled as needed
-via Kconfig (e.g. ``CONFIG_POSIX_C_LIB_EXT=y``). Further fine-tuning may be accomplished via
-:ref:`additional POSIX-related Kconfig options <posix_kconfig_options>`.
+Libraries should depend on :kconfig:option:`CONFIG_POSIX_SYSTEM_INTERFACES` and other
+POSIX :ref:`Option Groups <posix_option_groups>`, as needed.
 
-Subprofiles, Options, and Option Groups should be considered the preferred way to configure POSIX
-in Zephyr going forward.
+Further fine-tuning may be accomplished via
+:ref:`additional POSIX-related Kconfig options <posix_kconfig_options>`.
 
 Legacy
 ++++++
 
 Historically, Zephyr used :kconfig:option:`CONFIG_POSIX_API` to configure a set of POSIX features
 that was overloaded and always increasing in size.
 
-* :kconfig:option:`CONFIG_POSIX_API`
-
-The option is now frozen, and can be considered equivalent to the following:
-
-* :kconfig:option:`CONFIG_POSIX_AEP_CHOICE_PSE51`
-* :kconfig:option:`CONFIG_POSIX_FD_MGMT`
-* :kconfig:option:`CONFIG_POSIX_MESSAGE_PASSING`
-* :kconfig:option:`CONFIG_POSIX_NETWORKING`
+The :kconfig:option:`CONFIG_POSIX_API` is now deprecated and is slated for removal in Zephyr
+v4.5.0.
 
-However, :kconfig:option:`CONFIG_POSIX_API` should be considered legacy and should not be used for
-new Zephyr applications.
+Applications should select a POSIX subprofile mentioned above.
 
 .. _IEEE: https://www.ieee.org/
 .. _IEEE Computer Society: https://www.computer.org/

drivers/modem/Kconfig

@@ -158,7 +158,7 @@ config MODEM_SOCKET
 	  Note that the modem socket uses runtime allocated file descriptors
 	  reserved from the fdtable, for which the max count is set using the
 	  Kconfig option ZVFS_OPEN_MAX. Make sure to update this value as both
-	  the modem sockets and the POSIX_API, if used, share them.
+	  the modem sockets and other POSIX APIs, if used, share them.
 
 config MODEM_SOCKET_PACKET_COUNT
 	int "Maximum number of stored packet sizes per socket"

drivers/wifi/nxp/Kconfig.nxp

@@ -1133,10 +1133,15 @@ if NXP_WIFI_SMOKE_TESTS
 
 config NXP_WIFI_SIGMA_AGENT
 	bool "Wi-Fi Alliance Sigma Agent Support"
-	select POSIX_API
-	select POSIX_THREADS
+	select POSIX_SYSTEM_INTERFACES
+	select POSIX_BASE_DEFINITIONS
+	select POSIX_AEP_REALTIME_MINIMAL
+	select POSIX_NETWORKING
+	imply EVENTFD
+	imply POSIX_FD_MGMT
+	imply POSIX_MULTI_PROCESS
+	imply XSI_SINGLE_PROCESS
 	select PTHREAD_CREATE_BARRIER
-	select POSIX_TIMERS
 	help
 	  This option is to enable Wi-Fi Alliance Sigma Agent support in the Wi-Fi driver.
 

include/zephyr/net/socket.h

@@ -374,7 +374,7 @@ __syscall void *zsock_get_context_object(int sock);
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/socket.html
  * for normative description.
  * This function is also exposed as `socket()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  *
  * If CONFIG_USERSPACE is enabled, the caller will be granted access to the
  * context object associated with the returned file descriptor.
@@ -391,7 +391,7 @@ __syscall int zsock_socket(int family, int type, int proto);
  * https://pubs.opengroup.org/onlinepubs/009695399/functions/socketpair.html
  * for normative description.
  * This function is also exposed as `socketpair()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_socketpair(int family, int type, int proto, int *sv);
 
@@ -401,7 +401,7 @@ __syscall int zsock_socketpair(int family, int type, int proto, int *sv);
  * @details
  * Close a network socket.
  * This function is also exposed as `close()`
- * if @kconfig{CONFIG_POSIX_API} is defined (in which case it
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined (in which case it
  * may conflict with generic POSIX `close()` function).
  */
 __syscall int zsock_close(int sock);
@@ -415,7 +415,7 @@ __syscall int zsock_close(int sock);
  * for normative description, but currently this function has no effect in
  * Zephyr and provided solely for compatibility with existing code.
  * This function is also exposed as `shutdown()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_shutdown(int sock, int how);
 
@@ -427,7 +427,7 @@ __syscall int zsock_shutdown(int sock, int how);
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/bind.html
  * for normative description.
  * This function is also exposed as `bind()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_bind(int sock, const struct sockaddr *addr,
 			 socklen_t addrlen);
@@ -440,7 +440,7 @@ __syscall int zsock_bind(int sock, const struct sockaddr *addr,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/connect.html
  * for normative description.
  * This function is also exposed as `connect()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_connect(int sock, const struct sockaddr *addr,
 			    socklen_t addrlen);
@@ -453,7 +453,7 @@ __syscall int zsock_connect(int sock, const struct sockaddr *addr,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/listen.html
  * for normative description.
  * This function is also exposed as `listen()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_listen(int sock, int backlog);
 
@@ -465,7 +465,7 @@ __syscall int zsock_listen(int sock, int backlog);
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/accept.html
  * for normative description.
  * This function is also exposed as `accept()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_accept(int sock, struct sockaddr *addr, socklen_t *addrlen);
 
@@ -477,7 +477,7 @@ __syscall int zsock_accept(int sock, struct sockaddr *addr, socklen_t *addrlen);
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/sendto.html
  * for normative description.
  * This function is also exposed as `sendto()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall ssize_t zsock_sendto(int sock, const void *buf, size_t len,
 			       int flags, const struct sockaddr *dest_addr,
@@ -491,7 +491,7 @@ __syscall ssize_t zsock_sendto(int sock, const void *buf, size_t len,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/send.html
  * for normative description.
  * This function is also exposed as `send()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 static inline ssize_t zsock_send(int sock, const void *buf, size_t len,
 				 int flags)
@@ -507,7 +507,7 @@ static inline ssize_t zsock_send(int sock, const void *buf, size_t len,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/sendmsg.html
  * for normative description.
  * This function is also exposed as `sendmsg()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall ssize_t zsock_sendmsg(int sock, const struct msghdr *msg,
 				int flags);
@@ -520,7 +520,7 @@ __syscall ssize_t zsock_sendmsg(int sock, const struct msghdr *msg,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/recvfrom.html
  * for normative description.
  * This function is also exposed as `recvfrom()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall ssize_t zsock_recvfrom(int sock, void *buf, size_t max_len,
 				 int flags, struct sockaddr *src_addr,
@@ -534,7 +534,7 @@ __syscall ssize_t zsock_recvfrom(int sock, void *buf, size_t max_len,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/recvmsg.html
  * for normative description.
  * This function is also exposed as `recvmsg()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall ssize_t zsock_recvmsg(int sock, struct msghdr *msg, int flags);
 
@@ -546,7 +546,7 @@ __syscall ssize_t zsock_recvmsg(int sock, struct msghdr *msg, int flags);
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/recv.html
  * for normative description.
  * This function is also exposed as `recv()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 static inline ssize_t zsock_recv(int sock, void *buf, size_t max_len,
 				 int flags)
@@ -561,7 +561,7 @@ static inline ssize_t zsock_recv(int sock, void *buf, size_t max_len,
  * This functions allow to (only) configure a socket for blocking or
  * non-blocking operation (O_NONBLOCK).
  * This function is also exposed as `fcntl()`
- * if @kconfig{CONFIG_POSIX_API} is defined (in which case
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined (in which case
  * it may conflict with generic POSIX `fcntl()` function).
  */
 __syscall int zsock_fcntl_impl(int sock, int cmd, int flags);
@@ -599,7 +599,7 @@ static inline int zsock_fcntl_wrapper(int sock, int cmd, ...)
  * `ZFD_IOCTL_FIONREAD`, to set non-blocking mode, and query the number of
  * bytes available to read, respectively.
  * This function is also exposed as `ioctl()`
- * if @kconfig{CONFIG_POSIX_API} is defined (in which case
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined (in which case
  * it may conflict with generic POSIX `ioctl()` function).
  */
 __syscall int zsock_ioctl_impl(int sock, unsigned long request, va_list ap);
@@ -630,7 +630,7 @@ static inline int zsock_ioctl_wrapper(int sock, unsigned long request, ...)
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/poll.html
  * for normative description.
  * This function is also exposed as `poll()`
- * if @kconfig{CONFIG_POSIX_API} is defined (in which case
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined (in which case
  * it may conflict with generic POSIX `poll()` function).
  */
 static inline int zsock_poll(struct zsock_pollfd *fds, int nfds, int timeout)
@@ -649,7 +649,7 @@ static inline int zsock_poll(struct zsock_pollfd *fds, int nfds, int timeout)
  * available in Linux (some options are dummy and provided to ease porting
  * of existing code).
  * This function is also exposed as `getsockopt()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_getsockopt(int sock, int level, int optname,
 			       void *optval, socklen_t *optlen);
@@ -665,7 +665,7 @@ __syscall int zsock_getsockopt(int sock, int level, int optname,
  * available in Linux (some options are dummy and provided to ease porting
  * of existing code).
  * This function is also exposed as `setsockopt()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_setsockopt(int sock, int level, int optname,
 			       const void *optval, socklen_t optlen);
@@ -678,7 +678,7 @@ __syscall int zsock_setsockopt(int sock, int level, int optname,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/getpeername.html
  * for normative description.
  * This function is also exposed as `getpeername()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_getpeername(int sock, struct sockaddr *addr,
 				socklen_t *addrlen);
@@ -691,7 +691,7 @@ __syscall int zsock_getpeername(int sock, struct sockaddr *addr,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/getsockname.html
  * for normative description.
  * This function is also exposed as `getsockname()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_getsockname(int sock, struct sockaddr *addr,
 				socklen_t *addrlen);
@@ -704,7 +704,7 @@ __syscall int zsock_getsockname(int sock, struct sockaddr *addr,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/gethostname.html
  * for normative description.
  * This function is also exposed as `gethostname()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_gethostname(char *buf, size_t len);
 
@@ -716,7 +716,7 @@ __syscall int zsock_gethostname(char *buf, size_t len);
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/inet_ntop.html
  * for normative description.
  * This function is also exposed as `inet_ntop()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 static inline char *zsock_inet_ntop(sa_family_t family, const void *src,
 				    char *dst, size_t size)
@@ -732,7 +732,7 @@ static inline char *zsock_inet_ntop(sa_family_t family, const void *src,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/inet_pton.html
  * for normative description.
  * This function is also exposed as `inet_pton()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 __syscall int zsock_inet_pton(sa_family_t family, const char *src, void *dst);
 
@@ -775,7 +775,7 @@ __syscall int z_zsock_getaddrinfo_internal(const char *host,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html
  * for normative description.
  * This function is also exposed as `getaddrinfo()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 int zsock_getaddrinfo(const char *host, const char *service,
 		      const struct zsock_addrinfo *hints,
@@ -789,7 +789,7 @@ int zsock_getaddrinfo(const char *host, const char *service,
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/freeaddrinfo.html
  * for normative description.
  * This function is also exposed as `freeaddrinfo()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 void zsock_freeaddrinfo(struct zsock_addrinfo *ai);
 
@@ -801,7 +801,7 @@ void zsock_freeaddrinfo(struct zsock_addrinfo *ai);
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/gai_strerror.html
  * for normative description.
  * This function is also exposed as `gai_strerror()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 const char *zsock_gai_strerror(int errcode);
 
@@ -836,7 +836,7 @@ const char *zsock_gai_strerror(int errcode);
  * http://pubs.opengroup.org/onlinepubs/9699919799/functions/getnameinfo.html
  * for normative description.
  * This function is also exposed as `getnameinfo()`
- * if @kconfig{CONFIG_POSIX_API} is defined.
+ * if @kconfig{CONFIG_POSIX_NETWORKING} is defined.
  */
 int zsock_getnameinfo(const struct sockaddr *addr, socklen_t addrlen,
 		      char *host, socklen_t hostlen,
@@ -1278,7 +1278,7 @@ struct socket_op_vtable {
  * Additionally, if non-zephyr-prefixed headers are used here,
  * native_sim pulls in those from the host rather than Zephyr's.
  */
-#if defined(CONFIG_POSIX_API)
+#if defined(CONFIG_POSIX_NETWORKING)
 #if !defined(ZEPHYR_INCLUDE_POSIX_ARPA_INET_H_)
 #include <arpa/inet.h>
 #endif
@@ -1294,6 +1294,6 @@ struct socket_op_vtable {
 #if !defined(ZEPHYR_INCLUDE_POSIX_SYS_SOCKET_H_)
 #include <sys/socket.h>
 #endif
-#endif /* CONFIG_POSIX_API */
+#endif /* CONFIG_POSIX_NETWORKING */
 
 #endif /* ZEPHYR_INCLUDE_NET_SOCKET_H_ */