Requirements#

This section contains all requirements for the SOME/IP Gateway, organized following the S-CORE docs-as-code requirements process.

Organization#

Requirements are structured in a three-level hierarchy following the S-CORE requirements engineering process:

Table 1 Requirements Hierarchy#

Level

Directory

Purpose

Stakeholder

requirements/stakeholder.rst

High-level needs and constraints from users, integrators, and safety

Feature

requirements/feature/

Derived from stakeholder requirements, scoped to a gateway feature

Component

requirements/component/

Derived from feature requirements, scoped to a specific component

Component Names#

The following component identifiers are used in requirement IDs and file names:

Table 2 Component Identifiers#

Component

Safety

Description

gatewayd

ASIL-B

Gateway daemon — bridges IPC and SOME/IP, E2E protection, ACL enforcement

someipd

QM

SOME/IP stack daemon — wraps vsomeip, handles network I/O and SOME/IP-SD

network_service

ASIL-B

IPC interface between gatewayd and someipd (SomeipMessageTransfer)

Requirement Identifier Scheme#

IDs follow the pattern <type>__<scope>__<title_snake_case>:

Table 3 Identifier Format#

Type Prefix

Format

Example

stkh_req

stkh_req__some_ip_gateway__<title>

stkh_req__some_ip_gateway__transparent_bridging

feat_req

feat_req__some_ip_gateway__<title>

feat_req__some_ip_gateway__e2e_protection

comp_req

comp_req__<component>__<title>

comp_req__gatewayd__msg_routing

aou_req

aou_req__<component>__<title>

aou_req__gatewayd__valid_config

Document Heading Standards#

All RST requirement files follow this structure:

  1. Copyright header (RST comment block)

  2. Document title — = overline/underline

  3. Descriptive introduction paragraph

  4. Requirement directives grouped by topic

  5. Sections within a file use - underline, subsections use ^

Mandatory Attributes#

Every requirement directive must include these attributes:

  • :id: — unique identifier per the scheme above

  • :status: — valid or draft

  • :safety: — QM or ASIL_B

  • :security: — YES or NO

  • :reqtype: — Functional, Interface, Process, or Non-Functional

  • :satisfies: — parent requirement ID (mandatory for feature and component levels)

  • :rationale: — justification text (mandatory for stakeholder level only)

Cross-References#