xref: /nrf52832-nimble/rt-thread/components/net/sal_socket/include/sal.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /*
2*10465441SEvalZero  * Copyright (c) 2006-2018, RT-Thread Development Team
3*10465441SEvalZero  *
4*10465441SEvalZero  * SPDX-License-Identifier: Apache-2.0
5*10465441SEvalZero  *
6*10465441SEvalZero  * Change Logs:
7*10465441SEvalZero  * Date           Author       Notes
8*10465441SEvalZero  * 2018-05-17     ChenYong     First version
9*10465441SEvalZero  */
10*10465441SEvalZero 
11*10465441SEvalZero #ifndef SAL_H__
12*10465441SEvalZero #define SAL_H__
13*10465441SEvalZero 
14*10465441SEvalZero #include <rtdevice.h>
15*10465441SEvalZero 
16*10465441SEvalZero #ifdef SAL_USING_POSIX
17*10465441SEvalZero #include <dfs_file.h>
18*10465441SEvalZero #endif
19*10465441SEvalZero 
20*10465441SEvalZero #ifdef __cplusplus
21*10465441SEvalZero extern "C" {
22*10465441SEvalZero #endif
23*10465441SEvalZero 
24*10465441SEvalZero #if !defined(socklen_t) && !defined(SOCKLEN_T_DEFINED)
25*10465441SEvalZero typedef uint32_t socklen_t;
26*10465441SEvalZero #endif
27*10465441SEvalZero 
28*10465441SEvalZero /* SAL socket magic word */
29*10465441SEvalZero #define SAL_SOCKET_MAGIC               0x5A10
30*10465441SEvalZero 
31*10465441SEvalZero /* The maximum number of sockets structure */
32*10465441SEvalZero #ifndef SAL_SOCKETS_NUM
33*10465441SEvalZero #define SAL_SOCKETS_NUM                DFS_FD_MAX
34*10465441SEvalZero #endif
35*10465441SEvalZero 
36*10465441SEvalZero /* The maximum number of protocol families */
37*10465441SEvalZero #ifndef SAL_PROTO_FAMILIES_NUM
38*10465441SEvalZero #define SAL_PROTO_FAMILIES_NUM         4
39*10465441SEvalZero #endif
40*10465441SEvalZero 
41*10465441SEvalZero /* SAL socket offset */
42*10465441SEvalZero #ifndef SAL_SOCKET_OFFSET
43*10465441SEvalZero #define SAL_SOCKET_OFFSET              0
44*10465441SEvalZero #endif
45*10465441SEvalZero 
46*10465441SEvalZero struct sal_socket_ops
47*10465441SEvalZero {
48*10465441SEvalZero     int (*socket)     (int domain, int type, int protocol);
49*10465441SEvalZero     int (*closesocket)(int s);
50*10465441SEvalZero     int (*bind)       (int s, const struct sockaddr *name, socklen_t namelen);
51*10465441SEvalZero     int (*listen)     (int s, int backlog);
52*10465441SEvalZero     int (*connect)    (int s, const struct sockaddr *name, socklen_t namelen);
53*10465441SEvalZero     int (*accept)     (int s, struct sockaddr *addr, socklen_t *addrlen);
54*10465441SEvalZero     int (*sendto)     (int s, const void *data, size_t size, int flags, const struct sockaddr *to, socklen_t tolen);
55*10465441SEvalZero     int (*recvfrom)   (int s, void *mem, size_t len, int flags, struct sockaddr *from, socklen_t *fromlen);
56*10465441SEvalZero     int (*getsockopt) (int s, int level, int optname, void *optval, socklen_t *optlen);
57*10465441SEvalZero     int (*setsockopt) (int s, int level, int optname, const void *optval, socklen_t optlen);
58*10465441SEvalZero     int (*shutdown)   (int s, int how);
59*10465441SEvalZero     int (*getpeername)(int s, struct sockaddr *name, socklen_t *namelen);
60*10465441SEvalZero     int (*getsockname)(int s, struct sockaddr *name, socklen_t *namelen);
61*10465441SEvalZero     int (*ioctlsocket)(int s, long cmd, void *arg);
62*10465441SEvalZero #ifdef SAL_USING_POSIX
63*10465441SEvalZero     int (*poll)       (struct dfs_fd *file, struct rt_pollreq *req);
64*10465441SEvalZero #endif
65*10465441SEvalZero };
66*10465441SEvalZero 
67*10465441SEvalZero struct sal_proto_ops
68*10465441SEvalZero {
69*10465441SEvalZero     struct hostent* (*gethostbyname)  (const char *name);
70*10465441SEvalZero     int             (*gethostbyname_r)(const char *name, struct hostent *ret, char *buf, size_t buflen, struct hostent **result, int *h_errnop);
71*10465441SEvalZero     int             (*getaddrinfo)    (const char *nodename, const char *servname, const struct addrinfo *hints, struct addrinfo **res);
72*10465441SEvalZero     void            (*freeaddrinfo)   (struct addrinfo *ai);
73*10465441SEvalZero };
74*10465441SEvalZero 
75*10465441SEvalZero struct sal_socket
76*10465441SEvalZero {
77*10465441SEvalZero     uint32_t magic;                    /* SAL socket magic word */
78*10465441SEvalZero 
79*10465441SEvalZero     int socket;                        /* SAL socket descriptor */
80*10465441SEvalZero     int domain;
81*10465441SEvalZero     int type;
82*10465441SEvalZero     int protocol;
83*10465441SEvalZero 
84*10465441SEvalZero     const struct sal_socket_ops *ops;  /* socket options */
85*10465441SEvalZero 
86*10465441SEvalZero     void *user_data;                   /* user-specific data */
87*10465441SEvalZero #ifdef SAL_USING_TLS
88*10465441SEvalZero     void *user_data_tls;               /* user-specific TLS data */
89*10465441SEvalZero #endif
90*10465441SEvalZero };
91*10465441SEvalZero 
92*10465441SEvalZero struct sal_proto_family
93*10465441SEvalZero {
94*10465441SEvalZero     int family;                        /* primary protocol families type */
95*10465441SEvalZero     int sec_family;                    /* secondary protocol families type */
96*10465441SEvalZero     int (*create)(struct sal_socket *sal_socket, int type, int protocol);   /* register socket options */
97*10465441SEvalZero 
98*10465441SEvalZero     struct sal_proto_ops *ops;             /* protocol family options */
99*10465441SEvalZero };
100*10465441SEvalZero 
101*10465441SEvalZero /* SAL(Socket Abstraction Layer) initialize */
102*10465441SEvalZero int sal_init(void);
103*10465441SEvalZero 
104*10465441SEvalZero struct sal_socket *sal_get_socket(int sock);
105*10465441SEvalZero 
106*10465441SEvalZero /* SAL protocol family register and unregister operate */
107*10465441SEvalZero int sal_proto_family_register(const struct sal_proto_family *pf);
108*10465441SEvalZero int sal_proto_family_unregister(int family);
109*10465441SEvalZero rt_bool_t sal_proto_family_is_registered(int family);
110*10465441SEvalZero struct sal_proto_family *sal_proto_family_find(int family);
111*10465441SEvalZero 
112*10465441SEvalZero #ifdef __cplusplus
113*10465441SEvalZero }
114*10465441SEvalZero #endif
115*10465441SEvalZero 
116*10465441SEvalZero #endif /* SAL_H__ */
117