mars_nwe/mars-nwe
1
0
Fork 0
Code Issues Pull Requests Actions Projects Releases 2 Wiki Activity

docs: document logical record sync request layouts

Browse Source
This commit is contained in:
Mario Fetka
2026-06-01 18:44:33 +00:00
parent d61f320a43
commit 2be5d7aeec
2 changed files with 77 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
src/nwconn.c
View File

@@ -2941,6 +2941,27 @@ static int handle_ncp_serv(void)
break;
case 0x9 : { /* Log Logical Record */
/*
* NCP 0x2222/09 Log Logical Record (old) logs one synchronization
* string in the caller's logical-record table. The string can be
* up to 128 characters long.
*
* SDK request layout:
*
* byte LockFlag: bit 0 asks the server to lock immediately
* word LockTimeout, in units of 1/18 second
* byte SynchNameLen
* bytes SynchName
*
* SDK reply: no reply data.
* SDK completion: 0x00 success, 0x96 server out of memory,
* 0xfe timeout, 0xff lock error.
*
* The current INPUT layout matches the documented old request
* header offsets: FunctionCode at offset 6, LockFlag at offset 7,
* LockTimeout at offset 8, SynchNameLen at offset 10, and
* SynchName at offset 11.
*/
struct INPUT {
uint8 header[7]; /* Requestheader */
uint8 lock_flag; /* 0 = log */
@@ -2960,6 +2981,24 @@ static int handle_ncp_serv(void)
break;
case 0xa : { /* Log Logical Record Set */
/*
* NCP 0x2222/10 Lock Logical Record Set (old) locks all logical
* records previously logged by this client. This direct old call
* is the compatibility form of NCP 0x2222/108.
*
* SDK request layout:
*
* byte LockFlag
* word LockTimeout, in units of 1/18 second
*
* SDK reply: no reply data.
* SDK completion: 0x00 success, 0xfe timeout, 0xff lock error.
*
* The old SDK page documents LockTimeout as word (Lo-Hi), while
* the newer 0x6c/108 call documents word (Hi-Lo). The existing
* code reads the field with GET_BE16(). This comment records the
* parser difference only; endpoint behaviour is unchanged here.
*/
struct INPUT {
uint8 header[7]; /* Requestheader */
uint8 lock_flag; /* 0 = log */
@@ -2982,10 +3021,14 @@ static int handle_ncp_serv(void)
* record from the calling task's synchronization table.
*
* SDK: NCP 0x2222/12 Release Logical Record releases/unlocks one
* synchronization string held by the calling client. The request
* is a one-byte Synch Name Length followed by the Synch Name
* (up to 128 bytes), returns no reply data, and reports success or
* Unlock Error through the completion code.
* synchronization string held by the calling client. Both requests
* use the old direct layout:
*
* byte SynchNameLen
* bytes SynchName
*
* They return no reply data and report success or Unlock Error
* through the completion code.
*
* Important semantic difference: Release Logical Record leaves the
* string in the caller's synchronization string table so a later
@@ -3010,6 +3053,24 @@ static int handle_ncp_serv(void)
case 0xe : /* Clear Logical Record Set */
case 0xd : { /* Release Logical Record Set */
/*
* NCP 0x2222/13 Release Logical Record Set releases all currently
* locked logical records but keeps the synchronization-string table.
* NCP 0x2222/14 Clear Logical Record Set releases all logical
* records and clears that table.
*
* SDK request for both calls:
*
* byte LockFlag
*
* SDK reply: no reply data.
* SDK completion: 0x00 success.
*
* MARS-NWE currently does not read the documented LockFlag byte
* and forwards the operation directly to share_handle_lock_sets().
* This documentation patch records that parser difference only;
* endpoint behaviour is intentionally unchanged here.
*/
int result = share_handle_lock_sets(
2, /* Logical Record Set */
(function==0xe)