SCP server - the rcp SINK state machine over an SSH exec channel (PROTOCORE_ENABLE_SSH_SCP). More...

#include "protocore_config.h"

Classes
struct	SshScpNs
	Dispatch table. Addressed by offset, so the layout is asserted below. More...

Functions
	PROTOCORE_NS_LAYOUT (SshScpNs, begin)

void	protocore_ssh_scp_begin (uint8_t *work)
	Serve SCP uploads onto the mounted filesystem. Installs the channel .

uint8_t *	protocore_ssh_scp_span (void)
	The PROTOCORE_SSH_SCP_BORROW bytes this module's state lives in.

Variables
PROTOCORE_NS SshScpNs SshScp	PROTOCORE_UNUSED = {.begin = protocore_ssh_scp_begin}
	Module namespace.

Detailed Description

SCP server - the rcp SINK state machine over an SSH exec channel (PROTOCORE_ENABLE_SSH_SCP).

Drives the SCP/RCP codec (network_drivers/session/scp) over an SSH exec "scp …" channel so a client can drop a file onto the device: scp localfile admin@device:/path. v1 serves the SINK direction (client -> device, scp -t); the SOURCE direction (scp -f, device -> client) is a follow-up - use SFTP get to download.

Storage is reached through the filesystem accessor (server/storage/filesystem.h), so this file names no vendor type and holds no mount, no root, and no path buffer. Mount the backend and set the root once with protocore_mnt_mount() + protocore_fs_begin(); every server over that storage then answers from the same root by construction rather than by each being told the same string.

Streamed writes, fixed buffers, no heap. Call protocore_ssh_scp_begin() once after protocore_ssh_conn_setup().

work is PROTOCORE_SSH_SCP_BORROW bytes the CALLER took, at an address it knows. It is not held past the call, so nothing here aliases it. How those bytes are carved is this module's and is never named here.

Author: Douglas Quigg (dstroy0)

Date: 2026

Definition in file ssh_scp.h.

Function Documentation

◆ PROTOCORE_NS_LAYOUT()

PROTOCORE_NS_LAYOUT	(	SshScpNs	,
		begin
	)

◆ protocore_ssh_scp_begin()

void protocore_ssh_scp_begin ( uint8_t * work )

Serve SCP uploads onto the mounted filesystem. Installs the channel .

Parameters

work	PROTOCORE_SSH_SCP_BORROW bytes the caller took. Not held past the call.

◆ protocore_ssh_scp_span()

uint8_t * protocore_ssh_scp_span ( void )

The PROTOCORE_SSH_SCP_BORROW bytes this module's state lives in.

Stated beside the namespace rather than on it: an entry takes a borrow, and this is where that borrow comes from. Taken once from the end of the pool, which no mark and no release walks, so the state lasts the life of the program.

Returns: the span.

Variable Documentation

◆ PROTOCORE_UNUSED

PROTOCORE_NS SshScpNs SshScp PROTOCORE_UNUSED = {.begin = protocore_ssh_scp_begin}

Module namespace.

Definition at line 59 of file ssh_scp.h.

Classes

Functions