Oryx Embedded

https://www.oryx-embedded.com/doc/
Admin
Oryx Embedded provides a suite of lightweight, high-performance networking and security libraries...
Tokens:7,404,440
Snippets:37,333
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start SFTP Server

Source: https://www.oryx-embedded.com/doc/sftp__server_8c.html

Starts the SFTP server instance.

```c
error_t sftpServerStart(SftpServerContext *context)
```

--------------------------------

### Start HTTP Server

Source: https://www.oryx-embedded.com/doc/http__server_8c_source.html

Starts the HTTP server instance.

```c
error_t httpServerStart(HttpServerContext *context)
```

--------------------------------

### Start Kernel

Source: https://www.oryx-embedded.com/doc/os__port__rtx_8c_source.html

Starts the OS kernel.

```c
void osStartKernel(OsInitTaskCode task)
```

--------------------------------

### Start TFTP Server

Source: https://www.oryx-embedded.com/doc/tftp__server_8c_source.html

Starts the TFTP server using the provided context.

```c
error_t tftpServerStart(TftpServerContext *context)
{
error_t error;

//Make sure the TFTP server context is valid
if(context == NULL)
return ERROR_INVALID_PARAMETER;

//Debug message
```

--------------------------------

### osStartKernel()

Source: https://www.oryx-embedded.com/doc/os__port__chibios_8c.html

Starts the kernel.

```APIDOC
## void osStartKernel(void)

### Description
Start kernel.
```

--------------------------------

### ikeStart()

Source: https://www.oryx-embedded.com/doc/ike_8c.html

Starts the IKE service.

```APIDOC
## ikeStart(IkeContext *context)

### Description
Start IKE service.

### Parameters
- **context** (IkeContext *) - Required - Pointer to the IKE context

### Returns
- **error_t** - Error code
```

--------------------------------

### ikeStart

Source: https://www.oryx-embedded.com/doc/ike_8c.html

Starts the IKE service.

```APIDOC
## error_t ikeStart(IkeContext *context)

### Description
Starts the IKE service.

### Parameters
- **context** (IkeContext*) - Pointer to the IKE context.
```

--------------------------------

### sftpServerStart

Source: https://www.oryx-embedded.com/doc/sftp__server_8c.html

Starts the SFTP server instance.

```APIDOC
## error_t sftpServerStart(SftpServerContext *context)

### Description
Start SFTP server.

### Parameters
- **context** (SftpServerContext*) - Required - Pointer to the server context.
```

--------------------------------

### Kernel Initialization and Start

Source: https://www.oryx-embedded.com/doc/os__port__embos_8c_source.html

Functions to initialize the kernel and start the scheduler.

```c
void osInitKernel(void)
{
//Disable interrupts
OS_IncDI();
//Kernel initialization
OS_InitKern();
//Hardware initialization
OS_InitHW();
}
```

```c
void osStartKernel(void)
{
//Start the scheduler
OS_Start();
}
```

--------------------------------

### Kernel Initialization and Start

Source: https://www.oryx-embedded.com/doc/os__port__sys__bios_8c_source.html

Functions to initialize and start the SYS/BIOS kernel.

```c
void osInitKernel(void)
{
//The scheduler is not running
running = FALSE;
}
```

```c
void osStartKernel(void)
{
//The scheduler is now running
running = TRUE;
//Start the scheduler
BIOS_start();
}
```

--------------------------------

### Start FTP server

Source: https://www.oryx-embedded.com/doc/ftp__server_8c.html

Starts the FTP server operation.

```c
error_t ftpServerStart(FtpServerContext *context)
```

--------------------------------

### tftpServerStart

Source: https://www.oryx-embedded.com/doc/tftp__server_8c.html

Starts the TFTP server instance.

```APIDOC
## error_t tftpServerStart(TftpServerContext *context)

### Description
Starts the TFTP server, allowing it to begin processing requests.

### Parameters
- **context** (TftpServerContext*) - Input - Pointer to the TFTP server context.

### Returns
- **error_t** - Returns an error code indicating the success or failure of the operation.
```

--------------------------------

### Start SCP Server

Source: https://www.oryx-embedded.com/doc/scp__server_8c_source.html

Starts the SCP server using the provided context.

```c
error_t scpServerStart(ScpServerContext *context)
{
error_t error;

//Make sure the SCP server context is valid
if(context == NULL)
return ERROR_INVALID_PARAMETER;

//Debug message
TRACE_INFO("Starting SCP server...\r\n");

//Make sure the SCP server is not already running
```

--------------------------------

### echoServerStart

Source: https://www.oryx-embedded.com/doc/echo__server_8c.html

Starts the Echo server instance.

```APIDOC
## error_t echoServerStart(EchoServerContext *context)

### Description
Starts the Echo server, allowing it to begin processing incoming data.

### Parameters
- **context** (EchoServerContext*) - Required - Pointer to the initialized Echo server context.

### Returns
- **error_t** - Returns an error code indicating the success or failure of the operation.
```

--------------------------------

### scpServerStart

Source: https://www.oryx-embedded.com/doc/scp__server_8c.html

Starts the SCP server instance.

```APIDOC
## error_t scpServerStart(ScpServerContext *context)

### Description
Start SCP server.

### Parameters
- **context** (ScpServerContext*) - Required - Pointer to the server context.
```

--------------------------------

### ftpServerStart

Source: https://www.oryx-embedded.com/doc/ftp__server_8c.html

Starts the FTP server instance.

```APIDOC
error_t ftpServerStart(FtpServerContext *context);
```

--------------------------------

### httpServerStart

Source: https://www.oryx-embedded.com/doc/http__server_8c.html

Starts the HTTP server instance.

```APIDOC
## error_t httpServerStart (HttpServerContext *context)

### Description
Start HTTP server.

### Parameters
- **context** (HttpServerContext*) - Required - Pointer to the server context.
```

--------------------------------

### httpServerStart

Source: https://www.oryx-embedded.com/doc/http__server_8c.html

Starts the HTTP server.

```APIDOC
## httpServerStart(HttpServerContext *context)

### Description
Starts the HTTP server.

### Parameters
- **context** (HttpServerContext*) - Required - Pointer to the HTTP server context.

### Returns
- **error_t** - Error code.
```

--------------------------------

### sshServerStart

Source: https://www.oryx-embedded.com/doc/ssh__server_8c.html

Starts the SSH server instance.

```APIDOC
## error_t sshServerStart(SshServerContext *context)

### Description
Start SSH server.

### Parameters
- **context** (SshServerContext*) - Required - Pointer to the server context.
```

--------------------------------

### dhcpServerStart

Source: https://www.oryx-embedded.com/doc/dhcp__server_8c.html

Starts the DHCP server.

```APIDOC
## error_t dhcpServerStart(DhcpServerContext *context)

### Description
Starts the DHCP server operation using the initialized context.

### Parameters
- **context** (DhcpServerContext*) - Required - Pointer to the DHCP server context.

### Returns
- **error_t** - Returns an error code indicating the result of the operation.
```

--------------------------------

### autoIpStart

Source: https://www.oryx-embedded.com/doc/auto__ip_8c_source.html

Starts the Auto-IP process.

```APIDOC
## error_t autoIpStart(AutoIpContext *context)

### Description
Starts the Auto-IP process for the specified context.

### Parameters
- **context** (AutoIpContext*) - Required - Pointer to the Auto-IP context.

### Returns
- **error_t** - Returns NO_ERROR on success.
```

--------------------------------

### Start 802.1X Supplicant

Source: https://www.oryx-embedded.com/doc/supplicant_8c_source.html

Initializes the 802.1X supplicant by opening a raw socket and preparing the environment.

```c
error_t supplicantStart(SupplicantContext *context)
{
error_t error;

//Make sure the supplicant context is valid
if(context == NULL)
return ERROR_INVALID_PARAMETER;

//Debug message
TRACE_INFO("Starting 802.1X supplicant...\r\n");

//Make sure the supplicant is not already running
if(context->running)
return ERROR_ALREADY_RUNNING;

//Start of exception handling block
do
{
//Open a raw socket
context->socket = socketOpenEx(context->netContext, SOCKET_TYPE_RAW_ETH,
ETH_TYPE_EAPOL);
//Failed to open socket?
if(context->socket == NULL)
{
//Report an error
error = ERROR_OPEN_FAILED;
break;
}

//Force the socket to operate in non-blocking mode
```

--------------------------------

### supplicantStart

Source: https://www.oryx-embedded.com/doc/supplicant_8c.html

Starts the 802.1X supplicant.

```APIDOC
## error_t supplicantStart(SupplicantContext *context)

### Description
Starts the 802.1X supplicant process.

### Parameters
- **context** (SupplicantContext *) - Required - Pointer to the 802.1X supplicant context

### Returns
- **error_t** - Error code
```

--------------------------------

### supplicantStart

Source: https://www.oryx-embedded.com/doc/supplicant_8c.html

Starts the 802.1X supplicant.

```APIDOC
## error_t supplicantStart(SupplicantContext *context)

### Description
Start 802.1X supplicant.

### Parameters
- **context** (SupplicantContext*) - Required - Pointer to the supplicant context.
```

--------------------------------

### Kernel Initialization and Start

Source: https://www.oryx-embedded.com/doc/os__port__cmsis__rtos_8c_source.html

Functions to initialize and start the RTOS kernel, handling version-specific API differences.

```c
void osInitKernel(void)
{
#if (osCMSIS >= 0x10001)
//Initialize the kernel
osKernelInitialize();
#endif
}


/**
* @brief Start kernel
**/

void osStartKernel(void)
{
#if (osCMSIS >= 0x10001)
//Start the kernel
osKernelStart();
#else
//Start the kernel
osKernelStart(NULL, NULL);
#endif
}
```

--------------------------------

### netStart

Source: https://www.oryx-embedded.com/doc/net_8h_source.html

Starts the TCP/IP stack operation.

```APIDOC
## netStart

### Description
Starts the TCP/IP stack.

### Signature
error_t netStart(NetContext *context)
```

--------------------------------

### authenticatorStart()

Source: https://www.oryx-embedded.com/doc/authenticator_8c.html

Starts the 802.1X authenticator process.

```APIDOC
## error_t authenticatorStart(AuthenticatorContext *context)

### Description
Starts the 802.1X authenticator.

### Parameters
- **context** (AuthenticatorContext *) - Required - Pointer to the 802.1X authenticator context

### Returns
- **error_t** - Error code
```

--------------------------------

### coapServerStart

Source: https://www.oryx-embedded.com/doc/coap__server_8c.html

Starts the CoAP server instance.

```APIDOC
## error_t coapServerStart(CoapServerContext *context)

### Description
Starts the CoAP server to begin processing requests.

### Parameters
- **context** (CoapServerContext*) - Required - Pointer to the initialized server context.
```

--------------------------------

### coapServerStart

Source: https://www.oryx-embedded.com/doc/coap__server_8c.html

Starts the CoAP server instance.

```APIDOC
## error_t coapServerStart(CoapServerContext *context)

### Description
Starts the CoAP server.

### Parameters
- **context** (CoapServerContext*) - Required - Pointer to the CoAP server context

### Returns
- **error_t** - Error code
```

--------------------------------

### Start Modbus/TCP Server

Source: https://www.oryx-embedded.com/doc/modbus__server_8c_source.html

Opens a TCP socket, binds to the interface, and starts the server task. Uses a do-while block for exception handling during the setup process.

```c
error_t modbusServerStart(ModbusServerContext *context)
{
error_t error;

//Make sure the Modbus/TCP server context is valid
if(context == NULL)
return ERROR_INVALID_PARAMETER;

//Debug message
TRACE_INFO("Starting Modbus/TCP server...\r\n");

//Make sure the Modbus/TCP server is not already running
if(context->running)
return ERROR_ALREADY_RUNNING;

//Start of exception handling block
do
{
//Open a TCP socket
context->socket = socketOpenEx(context->netContext, SOCKET_TYPE_STREAM,
SOCKET_IP_PROTO_TCP);
//Failed to open socket?
if(context->socket == NULL)
{
//Report an error
error = ERROR_OPEN_FAILED;
break;
}

//Force the socket to operate in non-blocking mode
error = socketSetTimeout(context->socket, 0);
//Any error to report?
if(error)
break;

//Associate the socket with the relevant interface
error = socketBindToInterface(context->socket, context->interface);
//Any error to report?
if(error)
break;

//The Modbus/TCP server listens for connection requests on port 502
error = socketBind(context->socket, &IP_ADDR_ANY, context->port);
//Any error to report?
if(error)
break;

//Place socket in listening state
error = socketListen(context->socket, 0);
//Any error to report?
if(error)
break;

//Start the Modbus/TCP server
context->stop = FALSE;
context->running = TRUE;

//Create a task
context->taskId = osCreateTask("Modbus/TCP Server",
(OsTaskCode) modbusServerTask, context, &context->taskParams);

//Failed to create task?
if(context->taskId == OS_INVALID_TASK_ID)
{
//Report an error
error = ERROR_OUT_OF_RESOURCES;
break;
}

//End of exception handling block
} while(0);

//Any error to report?
if(error)
{
//Clean up side effects
context->running = FALSE;

//Close listening socket
socketClose(context->socket);
context->socket = NULL;
}

//Return status code
return error;
}
```

--------------------------------

### Start TFTP Server

Source: https://www.oryx-embedded.com/doc/tftp__server_8c_source.html

Initializes the TFTP server by opening a UDP socket, binding to an interface and port, and creating the server task.

```c
170 TRACE_INFO("Starting TFTP server...\r\n");
171
172 //Make sure the TFTP server is not already running
173 if(context->running)
174 return ERROR_ALREADY_RUNNING;
175
176 //Start of exception handling block
177 do
178 {
179 //Open a UDP socket
180 context->socket = socketOpenEx(context->netContext, SOCKET_TYPE_DGRAM,
181 SOCKET_IP_PROTO_UDP);
182 //Failed to open socket?
183 if(context->socket == NULL)
184 {
185 //Report an error
186 error = ERROR_OPEN_FAILED;
187 break;
188 }
189
190 //Associate the socket with the relevant interface
191 error = socketBindToInterface(context->socket, context->interface);
192 //Unable to bind the socket to the desired interface?
193 if(error)
194 break;
195
196 //The TFTP server listens for connection requests on port 69
197 error = socketBind(context->socket, &IP_ADDR_ANY, context->port);
198 //Unable to bind the socket to the desired port?
199 if(error)
200 break;
201
202 //Start the TFTP server
203 context->stop = FALSE;
204 context->running = TRUE;
205
206 //Create a task
207 context->taskId = osCreateTask("TFTP Server", (OsTaskCode) tftpServerTask,
208 context, &context->taskParams);
209
210 //Failed to create task?
211 if(context->taskId == OS_INVALID_TASK_ID)
212 {
213 //Report an error
214 error = ERROR_OUT_OF_RESOURCES;
215 break;
216 }
217
218 //End of exception handling block
219 } while(0);
220
221 //Any error to report?
222 if(error)
223 {
224 //Clean up side effects
225 context->running = FALSE;
226
227 //Close the UDP socket
228 socketClose(context->socket);
229 context->socket = NULL;
230 }
231
232 //Return status code
233 return error;
234 }
```

--------------------------------

### dhcpClientStart

Source: https://www.oryx-embedded.com/doc/dhcp__client_8c.html

Starts the DHCP client process.

```APIDOC
## error_t dhcpClientStart(DhcpClientContext *context)

### Description
Start DHCP client.

### Parameters
- **context** (DhcpClientContext*) - Input - Pointer to the DHCP client context

### Returns
- **error_t** - Error code
```

--------------------------------

### Start Authenticator

Source: https://www.oryx-embedded.com/doc/authenticator_8c_source.html

Starts the 802.1X authenticator service.

```c
error_t authenticatorStart(AuthenticatorContext *context)
```

--------------------------------

### lldpStart()

Source: https://www.oryx-embedded.com/doc/lldp_8h.html

Starts the LLDP agent using the provided context.

```APIDOC
## lldpStart()

### Description
Starts the LLDP agent.

### Signature
`error_t lldpStart(LldpAgentContext *context)`

### Parameters
- **context** (LldpAgentContext*) - Required - Pointer to the LLDP agent context.

### Returns
- **error_t** - Error code.
```

--------------------------------

### Start Modbus Server

Source: https://www.oryx-embedded.com/doc/modbus__server_8c.html

Starts the Modbus/TCP server operation.

```c
error_t modbusServerStart (ModbusServerContext *context)
```

--------------------------------

### Start mDNS Responder

Source: https://www.oryx-embedded.com/doc/mdns__responder_8c.html

Starts the mDNS responder service.

```c
error_t mdnsResponderStart(MdnsResponderContext *context)
```

--------------------------------

### Configure and Start Echo Server

Source: https://www.oryx-embedded.com/doc/echo__server_8c_source.html

Initializes TCP and UDP sockets, binds them to interfaces, and creates the server task.

```c
error = socketBindToInterface(context->tcpSocket, context->interface);
//Any error to report?
if(error)
break;

//The Echo server listens for TCP connection requests on port 7
error = socketBind(context->tcpSocket, &IP_ADDR_ANY, context->port);
//Any error to report?
if(error)
break;

//Place socket in listening state
error = socketListen(context->tcpSocket, 0);
//Any error to report?
if(error)
break;
#endif

#if (ECHO_SERVER_UDP_SUPPORT == ENABLED)
//Open a UDP socket
context->udpSocket = socketOpenEx(context->netContext, SOCKET_TYPE_DGRAM,
SOCKET_IP_PROTO_UDP);
//Failed to open socket?
if(context->udpSocket == NULL)
{
//Report an error
error = ERROR_OPEN_FAILED;
break;
}

//Force the socket to operate in non-blocking mode
error = socketSetTimeout(context->udpSocket, 0);
//Any error to report?
if(error)
break;

//Associate the socket with the relevant interface
error = socketBindToInterface(context->udpSocket, context->interface);
//Any error to report?
if(error)
break;

//The Echo server listens for UDP datagrams on port 7
error = socketBind(context->udpSocket, &IP_ADDR_ANY, context->port);
//Any error to report?
if(error)
break;
#endif

//Start the Echo server
context->stop = FALSE;
context->running = TRUE;

//Create a task
context->taskId = osCreateTask("Echo Server", (OsTaskCode) echoServerTask,
context, &context->taskParams);

//Failed to create task?
if(context->taskId == OS_INVALID_TASK_ID)
{
//Report an error
error = ERROR_OUT_OF_RESOURCES;
break;
}

//End of exception handling block
} while(0);

//Any error to report?
if(error)
{
//Clean up side effects
context->running = FALSE;

#if (ECHO_SERVER_TCP_SUPPORT == ENABLED)
//Close listening TCP socket
socketClose(context->tcpSocket);
context->tcpSocket = NULL;
#endif

#if (ECHO_SERVER_UDP_SUPPORT == ENABLED)
//Close UDP socket
socketClose(context->udpSocket);
context->udpSocket = NULL;
#endif
}

//Return status code
return error;
}
```

--------------------------------

### Start SFTP Server

Source: https://www.oryx-embedded.com/doc/sftp__server_8c_source.html

Initializes the SFTP server by registering callbacks and creating the server task. Returns an error if the context is invalid or the server is already running.

```c
error_t sftpServerStart(SftpServerContext *context)
{
error_t error;

//Make sure the SFTP server context is valid
if(context == NULL)
return ERROR_INVALID_PARAMETER;

//Debug message
TRACE_INFO("Starting SFTP server...\r\n");

//Make sure the SFTP server is not already running
if(context->running)
return ERROR_ALREADY_RUNNING;

//Register channel request processing callback
error = sshServerRegisterChannelRequestCallback(context->sshServerContext,
sftpServerChannelRequestCallback, context);

//Check status code
if(!error)
{
//Start the SFTP server
context->stop = FALSE;
context->running = TRUE;

//Create a task
context->taskId = osCreateTask("SFTP Server", (OsTaskCode) sftpServerTask,
context, &context->taskParams);

//Failed to create task?
if(context->taskId == OS_INVALID_TASK_ID)
{
error = ERROR_OUT_OF_RESOURCES;
}
}

//Any error to report?
if(error)
{
//Clean up side effects
context->running = FALSE;

//Unregister channel request processing callback
sshServerUnregisterChannelRequestCallback(context->sshServerContext,
sftpServerChannelRequestCallback);
}

//Return status code
return error;
}
```

--------------------------------

### Start DNS-SD responder

Source: https://www.oryx-embedded.com/doc/dns__sd__responder_8c.html

Starts the DNS-SD responder process.

```c
error_t dnsSdResponderStart(DnsSdResponderContext *context)
```

--------------------------------

### Kernel Initialization and Start

Source: https://www.oryx-embedded.com/doc/os__port__safertos_8c_source.html

Functions to initialize and start the SafeRTOS scheduler.

```c
void osInitKernel(void)
{
//Initialize kernel
xInitializeScheduler();
}

void osStartKernel(void)
{
//Start the scheduler
xTaskStartScheduler(pdTRUE);
}
```

--------------------------------

### Initialize File System

Source: https://www.oryx-embedded.com/doc/fs__port__rl__fs_8c_source.html

Initializes the file system and mounts the 'M0:' drive.

```c
__weak_func error_t fsInit(void)
{
error_t error;
fsStatus status;

//Initialize file system
status = finit("M0:");

//Check status code
if(status == fsOK)
{
//Mount drive
status = fmount("M0:");
}

//On success, fsOK is returned
if(status == fsOK)
{
error = NO_ERROR;
}
else
{
error = ERROR_FAILURE;
}

//Return status code
return error;
}
```

--------------------------------

### File System Initialization

Source: https://www.oryx-embedded.com/doc/fs__port__fatfs_8c_source.html

Initializes the file system, sets up mutexes, and mounts the FatFs volume.

```c
error_t fsInit(void)
{
	FRESULT res;

	//Clear file system objects
	osMemset(fileTable, 0, sizeof(fileTable));
	osMemset(dirTable, 0, sizeof(dirTable));

	//Create a mutex to protect critical sections
	if(!osCreateMutex(&fsMutex))
	{
		//Failed to create mutex
		return ERROR_OUT_OF_RESOURCES;
	}

	//Mount file system
#if (FATFS_REVISON <= FATFS_R(0, 9, b))
	res = f_mount(0, &fs);
#else
	res = f_mount(&fs, "", 1);
#endif

	//Failed to mount file system?
	if(res != FR_OK)
	{
		//Clean up side effects
		osDeleteMutex(&fsMutex);
		//Report an error
		return ERROR_FAILURE;
	}

	//Successful processing
	return NO_ERROR;
}
```

--------------------------------

### Start NAT Operation

Source: https://www.oryx-embedded.com/doc/nat_8c.html

Starts the NAT operation for the given context.

```c
error_t natStart(NatContext *context)
```

--------------------------------

### shellServerStart()

Source: https://www.oryx-embedded.com/doc/shell__server_8c.html

Initializes and starts the shell server using the provided context.

```APIDOC
## shellServerStart()

### Description
Starts the shell server.

### Parameters
- **context** (ShellServerContext *) - Required - Pointer to the shell server context

### Returns
- **error_t** - Error code
```

--------------------------------

### IPsec Port Range Start

Source: https://www.oryx-embedded.com/doc/ike_8c_source.html

Starting port number for an IPsec range.

```c
uint16_t start
```

--------------------------------

### presentInit

Source: https://www.oryx-embedded.com/doc/present_8c.html

Initializes the PRESENT context and performs key expansion.

```APIDOC
## presentInit

### Description
Initializes the PRESENT context and performs key expansion.

### Signature
`error_t presentInit(PresentContext *context, const uint8_t *key, size_t keyLen)`

### Parameters
- **context** (PresentContext*) - Pointer to the PRESENT context structure.
- **key** (const uint8_t*) - Pointer to the encryption key.
- **keyLen** (size_t) - Length of the key in bytes.
```

--------------------------------

### supplicantStart

Source: https://www.oryx-embedded.com/doc/supplicant_8h_source.html

Starts the supplicant authentication process.

```APIDOC
error_t supplicantStart(SupplicantContext *context);
```

--------------------------------

### void supplicantInitFsm(SupplicantContext *context)

Source: https://www.oryx-embedded.com/doc/supplicant__fsm_8h.html

Initializes the 802.1X supplicant state machine.

```APIDOC
## void supplicantInitFsm(SupplicantContext *context)

### Description
Initializes the 802.1X supplicant state machine.

### Parameters
- **context** (SupplicantContext *) - Pointer to the 802.1X supplicant context.
```

--------------------------------

### IPsec Address Range Start

Source: https://www.oryx-embedded.com/doc/ike_8c_source.html

Starting IP address for an IPsec range.

```c
IpAddr start
```

--------------------------------

### fsInit

Source: https://www.oryx-embedded.com/doc/fs__port__fatfs_8c.html

Initializes the file system.

```APIDOC
## error_t fsInit (void)

### Description
Initializes the file system.

### Returns
- **error_t** - Returns an error code indicating the result of the initialization.
```

--------------------------------

### Process setup request

Source: https://www.oryx-embedded.com/doc/usbd__rndis_8c.html

Processes an incoming setup request for the RNDIS class.

```c
uint8_t usbdRndisSetup(USBD_HandleTypeDef *pdev, USBD_SetupReqTypedef *req)
```

--------------------------------

### Kernel Initialization and Start

Source: https://www.oryx-embedded.com/doc/os__port__cmx__rtx_8c_source.html

Functions to initialize the semaphore table and start the CMX-RTX kernel.

```c
void osInitKernel(void)
{
//Clear semaphore ID allocation table
osMemset(semaphoreTable, 0, sizeof(semaphoreTable));
//Initialize the kernel
K_OS_Init();
}

void osStartKernel(void)
{
//Start the scheduler
K_OS_Start();
}
```

--------------------------------

### Set and Get lldpReinitDelay

Source: https://www.oryx-embedded.com/doc/lldp__mib__impl__config_8c_source.html

Functions to set and get the lldpReinitDelay MIB object value.

```c
error_t lldpMibSetLldpReinitDelay(const MibObject *object, const uint8_t *oid,
size_t oidLen, const MibVariant *value, size_t valueLen, bool_t commit)
{
#if (LLDP_MIB_SET_SUPPORT == ENABLED)
error_t error;

//Ensure that the supplied value is valid
if(value->integer >= 0)
{
//This object indicates the delay (in units of seconds) from when
//lldpPortConfigAdminStatus object of a particular port becomes disabled
//until re-initialization will be attempted
error = lldpMgmtSetReinitDelay(lldpMibBase.lldpAgentContext,
value->integer, commit);
}
else
{
//Report an error
error = ERROR_WRONG_VALUE;
}

//Return status code
return error;
#else
//SET operation is not supported
return ERROR_WRITE_FAILED;
#endif
}
```

```c
error_t lldpMibGetLldpReinitDelay(const MibObject *object, const uint8_t *oid,
size_t oidLen, MibVariant *value, size_t *valueLen)
{
error_t error;
uint_t reinitDelay;

//This object indicates the delay (in units of seconds) from when
//lldpPortConfigAdminStatus object of a particular port becomes disabled
//until re-initialization will be attempted
error = lldpMgmtGetReinitDelay(lldpMibBase.lldpAgentContext, &reinitDelay);

//Check status code
if(!error)
{
//Return the value of the object
value->integer = reinitDelay;
}

//Return status code
return error;
}
```

--------------------------------

### IKE Traffic Selector Start Port

Source: https://www.oryx-embedded.com/doc/ike__misc_8c_source.html

Start port for IKE traffic selector parameters.

```c
uint16_t startPort
```

--------------------------------

### xteaInit()

Source: https://www.oryx-embedded.com/doc/sam9x6__crypto__cipher_8c.html

Initializes an XTEA context with a provided key.

```APIDOC
## xteaInit()

### Description
Initializes a XTEA context using the supplied key and performs key expansion.

### Parameters
- **context** (XteaContext*) - Required - Pointer to the XTEA context to initialize
- **key** (const uint8_t*) - Required - Pointer to the key
- **keyLen** (size_t) - Required - Length of the key (must be set to 16)

### Returns
- **error_t** - Error code
```

--------------------------------

### Start Auto-IP Process

Source: https://www.oryx-embedded.com/doc/auto__ip_8c_source.html

Starts the Auto-IP process by resetting the configuration and initializing the state machine.

```c
error_t autoIpStart(AutoIpContext *context)
{
//Make sure the Auto-IP context is valid
if(context == NULL)
return ERROR_INVALID_PARAMETER;

//Debug message
TRACE_INFO("Starting Auto-IP...\r\n");

//Get exclusive access
netLock(context->netContext);

//Reset Auto-IP configuration
autoIpResetConfig(context);

//Initialize state machine
```

--------------------------------

### SCEP Client Initialization and Configuration Functions

Source: https://www.oryx-embedded.com/doc/scep__client_8h_source.html

Functions for initializing the client and registering various callbacks.

```c
298 error_t scepClientInit(ScepClientContext *context);

300 #if (SCEP_CLIENT_TLS_SUPPORT == ENABLED)

302 error_t scepClientRegisterTlsInitCallback(ScepClientContext *context,
303 ScepClientTlsInitCallback callback);

305 #endif

307 error_t scepClientRegisterCaCertVerifyCallback(ScepClientContext *context,
308 ScepClientCaCertVerifyCallback callback);

310 error_t scepClientRegisterCsrGenCallback(ScepClientContext *context,
311 ScepClientCsrGenCallback callback);

313 error_t scepClientRegisterSelfSignedCertGenCallback(ScepClientContext *context,
314 ScepClientSelfSignedCertGenCallback callback);

316 error_t scepClientSetPrng(ScepClientContext *context, const PrngAlgo *prngAlgo,
317 void *prngContext);

319 error_t scepClientSetTimeout(ScepClientContext *context, systime_t timeout);

321 error_t scepClientSetHost(ScepClientContext *context, const char_t *host);
322 error_t scepClientSetUri(ScepClientContext *context, const char_t *uri);

324 error_t scepClientBindToInterface(ScepClientContext *context,
325 NetInterface *interface);
```

--------------------------------

### MIB-II Object Definition Example

Source: https://www.oryx-embedded.com/doc/mib2__module_8c_source.html

Example of an object definition within the MIB-II object array.

```c
{
"snmpEnableAuthenTraps",
{43, 6, 1, 2, 1, 11, 30},
7,
ASN1_CLASS_UNIVERSAL,
ASN1_TYPE_INTEGER,
MIB_ACCESS_READ_WRITE,
&mib2Base.snmpGroup.snmpEnableAuthenTraps,
NULL,
sizeof(int32_t),
NULL,
NULL,
NULL
}
```

--------------------------------

### RNDIS Setup Request Handler

Source: https://www.oryx-embedded.com/doc/usbd__rndis_8c_source.html

Processes incoming USB setup requests for the RNDIS class.

```c
uint8_t usbdRndisSetup(USBD_HandleTypeDef *pdev, USBD_SetupReqTypedef *req)
{
	//Debug message
	TRACE_DEBUG("USB setup packet received...\r\n");
	TRACE_DEBUG(" bmRequest = 0x%02" PRIX8 "\r\n", req->bmRequest);
```

--------------------------------

### netif_set_up

Source: https://www.oryx-embedded.com/doc/esp8266__driver_8c.html

Handles the link-up event for the network interface.

```APIDOC
## netif_set_up(struct netif *netif)

### Description
Process link-up event for the specified network interface.

### Parameters
- **netif** (struct netif *) - Required - Underlying network interface
```

--------------------------------

### WebSocket GUID Constant

Source: https://www.oryx-embedded.com/doc/web__socket__misc_8c.html

The standard GUID string used for WebSocket protocol handshake calculations.

```c
const char_t webSocketGuid[] = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
```

--------------------------------

### Define SUPPLICANT_DEFAULT_MAX_START

Source: https://www.oryx-embedded.com/doc/supplicant_8h.html

Sets the default maximum number of start attempts to 3.

```c
#define SUPPLICANT_DEFAULT_MAX_START 3
```

--------------------------------

### netInit

Source: https://www.oryx-embedded.com/doc/net_8h_source.html

Initializes the TCP/IP stack with the provided settings.

```APIDOC
## netInit

### Description
Initializes the TCP/IP stack using the provided context and configuration settings.

### Signature
`error_t netInit(NetContext *context, const NetSettings *settings)`
```

--------------------------------

### Start mDNS Responder

Source: https://www.oryx-embedded.com/doc/mdns__responder_8c_source.html

Starts the mDNS responder by setting the running flag and initializing the state machine.

```c
error_t mdnsResponderStart(MdnsResponderContext *context)
{
//Make sure the mDNS responder context is valid
if(context == NULL)
return ERROR_INVALID_PARAMETER;

//Debug message
TRACE_INFO("Starting mDNS responder...\r\n");

//Get exclusive access
netLock(context->netContext);

//Start mDNS responder
context->running = TRUE;
//Initialize state machine
context->state = MDNS_STATE_INIT;

//Release exclusive access
netUnlock(context->netContext);

//Successful processing
return NO_ERROR;
}
```

--------------------------------

### W5200 Initialization Hook

Source: https://www.oryx-embedded.com/doc/w5200__driver_8c_source.html

Weak function for custom initialization logic during interface setup.

```c
__weak_func void w5200InitHook(NetInterface *interface)
{
}
```

--------------------------------

### ikeInit()

Source: https://www.oryx-embedded.com/doc/ike_8c.html

Initializes the IKE service context with the provided settings.

```APIDOC
## ikeInit()

### Description
IKE service initialization.

### Parameters
- **context** (IkeContext *) - Required - Pointer to the IKE context
- **settings** (const IkeSettings *) - Required - IKE specific settings

### Returns
- **error_t** - Error code
```

--------------------------------

### Start Echo Server

Source: https://www.oryx-embedded.com/doc/echo__server_8c_source.html

Starts the Echo server by opening a TCP socket and configuring it for non-blocking operation.

```c
error_t echoServerStart(EchoServerContext *context)
{
error_t error;

//Make sure the Echo server context is valid
if(context == NULL)
return ERROR_INVALID_PARAMETER;

//Debug message
TRACE_INFO("Starting Echo server...\r\n");

//Make sure the Echo server is not already running
if(context->running)
return ERROR_ALREADY_RUNNING;

//Start of exception handling block
do
{
#if (ECHO_SERVER_TCP_SUPPORT == ENABLED)
//Open a TCP socket
context->tcpSocket = socketOpenEx(context->netContext, SOCKET_TYPE_STREAM,
SOCKET_IP_PROTO_TCP);
//Failed to open socket?
if(context->tcpSocket == NULL)
{
//Report an error
error = ERROR_OPEN_FAILED;
break;
}

//Force the socket to operate in non-blocking mode
error = socketSetTimeout(context->tcpSocket, 0);
//Any error to report?
if(error)
break;

//Associate the socket with the relevant interface
```

--------------------------------

### Handle Soft-AP Start Event

Source: https://www.oryx-embedded.com/doc/esp32__wifi__driver_8c_source.html

Registers the RX callback and updates the link state when the Soft-AP interface starts.

```c
void esp32WifiApStartEvent(void *arg, esp_event_base_t eventBase,
int32_t eventId, void *eventData)
{
	esp_err_t ret;

	//Debug message
	TRACE_INFO("ESP32: AP start event\r\n");

	//Register RX callback
	ret = esp_wifi_internal_reg_rxcb(ESP_IF_WIFI_AP, esp32WifiApRxCallback);

	//Check status code
	if(ret == ESP_OK)
	{
		//Valid AP interface?
		if(esp32WifiApInterface != NULL)
		{
			//The link is up
		esp32WifiApInterface->linkState = TRUE;

			//Get exclusive access
			netLock(esp32WifiApInterface->netContext);
			//Process link state change event
			nicNotifyLinkChange(esp32WifiApInterface);
			//Release exclusive access
			netUnlock(esp32WifiApInterface->netContext);
		}
	}
}
```

--------------------------------

### Initialize FTP server

Source: https://www.oryx-embedded.com/doc/ftp__server_8c.html

Initializes the FTP server context with the specified settings.

```c
error_t ftpServerInit(FtpServerContext *context, const FtpServerSettings *settings)
```

--------------------------------

### Get CoAP Request Method

Source: https://www.oryx-embedded.com/doc/coap__server__request_8c_source.html

Retrieves the method code (GET, POST, PUT, or DELETE) from the CoAP request context.

```c
error_t coapServerGetMethodCode(CoapServerContext *context, CoapCode *code)
{
//Check parameters
if(context == NULL || code == NULL)
return ERROR_INVALID_PARAMETER;

//Get request method
return coapGetCode(&context->request, code);
}
```

--------------------------------

### osInitKernel()

Source: https://www.oryx-embedded.com/doc/os__port__cmsis__rtos2_8c.html

Initializes the RTOS kernel.

```APIDOC
## void osInitKernel(void)

### Description
Performs kernel initialization.
```

--------------------------------

### Initialize GPIO

Source: https://www.oryx-embedded.com/doc/stm32mp2xx__eth2__driver_8c_source.html

Placeholder for GPIO configuration logic.

```c
__weak_func void stm32mp2xxEth2InitGpio(NetInterface *interface)
{
//STM32MP257F-EV1 evaluation board?
#if defined(USE_STM32MP257F_EV1)
#endif
}
```

--------------------------------

### Modular Exponentiation Setup

Source: https://www.oryx-embedded.com/doc/same54__crypto__pkc_8c_source.html

Initializes the PUKCC accelerator for modular exponentiation, including reduction constant setup and workspace allocation.

```c
error_t mpiExpMod(Mpi *r, const Mpi *a, const Mpi *e, const Mpi *p)
{
	error_t error;
	size_t n;
	size_t modLen;
	size_t expLen;
	uint8_t *pos;
	PukccExpModParams params = {0};

	//Get the length of the input integer, in bytes
	n = mpiGetByteLength(a);

	//Get the length of the modulus, in bytes
	modLen = mpiGetByteLength(p);
	modLen = (modLen + 3U) & ~3U;

	//Get the length of the exponent, in bytes
	expLen = mpiGetByteLength(e);
	expLen = (expLen + 3U) & ~3U;

	//Check the length of the input integer
	if(n > (2 * modLen + 4))
		return ERROR_INVALID_LENGTH;

	//Acquire exclusive access to the PUKCC accelerator
	osAcquireMutex(&same54CryptoMutex);

	//Point to the crypto memory
	pos = (uint8_t *) PUKCC_CRYPTO_RAM_BASE;

	//Copy modulus
	params.mod = pukccImportMpi(&pos, p, modLen + 4);
	//Initialize reduction constant
	params.cns = pukccWorkspace(&pos, modLen + 12);
	//Initialize workspace R
	params.r = pukccWorkspace(&pos, 64);
	//Initialize workspace X
	params.x = pukccWorkspace(&pos, 2 * modLen + 8);

	//Set RedMod service parameters
	PUKCL(u2Option) = PUKCL_REDMOD_SETUP;
	PUKCL(Specific).CarryIn = 0;
	PUKCL(Specific).Gf2n = 0;
	PUKCL_RedMod(u2ModLength) = modLen;
	PUKCL_RedMod(nu1ModBase) = PUKCC_FAR_TO_NEAR(params.mod);
	PUKCL_RedMod(nu1CnsBase) = PUKCC_FAR_TO_NEAR(params.cns);
	PUKCL_RedMod(nu1RBase) = PUKCC_FAR_TO_NEAR(params.r);
	PUKCL_RedMod(nu1XBase) = PUKCC_FAR_TO_NEAR(params.x);

	//Perform modular reduction setup
	vPUKCL_Process(RedMod, pvPUKCLParam);

	//Check status code
	if(PUKCL(u2Status) == PUKCL_OK)
	{
		//Point to the crypto memory
		pos = params.r;

		//Copy input number
		params.x = pukccImportMpi(&pos, a, 2 * modLen + 8);

		//Set RedMod service parameters
		PUKCL(u2Option) = PUKCL_REDMOD_REDUCTION | PUKCL_REDMOD_USING_FASTRED;
		PUKCL(Specific).CarryIn = 0;
		PUKCL(Specific).Gf2n = 0;
		PUKCL_RedMod(u2ModLength) = modLen;
		PUKCL_RedMod(nu1ModBase) = PUKCC_FAR_TO_NEAR(params.mod);
		PUKCL_RedMod(nu1CnsBase) = PUKCC_FAR_TO_NEAR(params.cns);
		PUKCL_RedMod(nu1RBase) = PUKCC_FAR_TO_NEAR(params.x);
		PUKCL_RedMod(nu1XBase) = PUKCC_FAR_TO_NEAR(params.x);

		//Perform fast modular reduction
```

--------------------------------

### A2FxxxM3 Send Setup Frame

Source: https://www.oryx-embedded.com/doc/a2fxxxm3__eth__driver_8c_source.html

Configures and sends a setup frame for the Ethernet MAC, typically used for address filtering.

```c
error_t a2fxxxm3EthSendSetup(NetInterface *interface)
{
	A2fxxxm3HashTableSetupFrame *setupFrame;

	//Make sure the current buffer is available for writing
	if((txCurDmaDesc->tdes0 & TDES0_OWN) != 0)
	{
		return ERROR_FAILURE;
	}

	//Point to the buffer where to format the setup frame
	setupFrame = (A2fxxxm3HashTableSetupFrame *) txCurDmaDesc->tdes2;

	//Clear contents
	osMemset(setupFrame, 0, sizeof(A2fxxxm3HashTableSetupFrame));

	//Set MAC address
	setupFrame->physicalAddr[0] = interface->macAddr.w[0];
	setupFrame->physicalAddr[1] = interface->macAddr.w[1];
	setupFrame->physicalAddr[2] = interface->macAddr.w[2];

	//Write the number of bytes to send
	txCurDmaDesc->tdes1 = sizeof(A2fxxxm3HashTableSetupFrame) & TDES1_TBS1_MASK;
	//The SET flag indicates that this is a setup frame descriptor
	txCurDmaDesc->tdes1 |= TDES1_SET | TDES1_TCH | TDES1_FT0;
	//Give the ownership of the descriptor to the DMA
	txCurDmaDesc->tdes0 |= TDES0_OWN;

	//Instruct the DMA to poll the transmit descriptor list
	MAC->CSR1 = 1;

	//Point to the next descriptor in the list
	txCurDmaDesc = (A2fxxxm3TxDmaDesc *) txCurDmaDesc->tdes3;

	//Data successfully written
	return NO_ERROR;
}
```
Tokens:
Raw