Nintendo Switch Brew - User contributions [en]

HIPC

2017-05-10T20:44:05Z

GovanifY: This is the whole cmdbuf size otherwise it throws an invalid IPC command error

== IPC Command Structure ==
This is an array of u32's.

{| class="wikitable" border="1"
! Word || Bits || Description
|-
| 0 || 15-0 || IPC version? Always 4.
|-
| 0 || 19-16 || Number of buf X descriptors (each: 2 words).
|-
| 0 || 23-20 || Number of buf A descriptors (each: 3 words).
|-
| 0 || 27-24 || Number of buf B descriptors (each: 3 words).
|-
| 0 || 31-28 || Number of type W desciptors (each: 3 words), never observed.
|-
| 1 || 9-0 || Total word count (in u32's).
|-
| 1 || 13-10 || If set to 2, enable buf C descriptor.
|-
| 1 || 31 || Enable handle descriptor.
|-
| ... || || Handle descriptor, if enabled.
|-
| ... || || Buf X descriptors, each one 2 words.
|-
| ... || || Buf A descriptors, each one 3 words.
|-
| ... || || Buf B descriptors, each one 3 words.
|-
| ... || || Type W descriptors, each one 3 words.
|-
| ... || || Padding
|-
| ... || || Raw data
|-
| ... || || Buf C descriptors, each one 2 words.
|}

=== Handle descriptor ===
There can only be one of this descriptor type. It is enabled by bit31 of the second word.

{| class="wikitable" border="1"
! Word || Bits || Description
|-
| 0 || 0 || Send current PID.
|-
| 0 || 4-1 || Number of handles.
|-
| 0 || 8-5 || Number of B-words for this special descriptor.
|-
| ... || || Handles
|-
| ... || || B-words, purpose unknown.
|}

=== Buffer descriptor A/B ===
This packing is so unnecessarily complex.

{| class="wikitable" border="1"
! Word || Bits || Description
|-
| 0 || || Lower 32-bits of size.
|-
| 1 || || Lower 32-bits of address.
|-
| 2 || 1-0 || Always set to 1 or 3. R/RW.
|-
| 2 || 4-2 || Bit 38-36 of address.
|-
| 2 || 27-24 || Bit 35-32 of size.
|-
| 2 || 31-28 || Bit 35-32 of address.
|}

=== Buffer descriptor C ===
{| class="wikitable" border="1"
! Word || Bits || Description
|-
| 0 || || Lower 32-bits of address.
|-
| 1 || 15-0 || Rest of address.
|-
| 1 || 31-16 || Size
|}

=== Buffer descriptor X ===
This one is packed even worse than A, they inserted the bit38-36 of the address ''on top'' of the counter field.

{| class="wikitable" border="1"
! Word || Bits || Description
|-
| 0 || 5-0 || Bits 5-0 of counter.
|-
| 0 || 8-6 || Bit 38-36 of address.
|-
| 0 || 11-9 || Bits 11-9 of counter.
|-
| 0 || 15-12 || Bit 35-32 of address.
|-
| 0 || 31-16 || Size
|-
| 1 || || Lower 32-bits of address.
|}

== Raw data portion ==
This is an array of u64's. It's always aligned to 16 so sometimes there is padding words before it.

{| class="wikitable" border="1"
! Word || Description
|-
| ... || Pid is written here if enabled.
|-
| +0 || Magic ("SFCI" for requests, "SFCO" for responses)
|-
| +1 || Cmd id
|-
| ... || Rest of raw data.
|}

== Official marshalling code ==
The official marshalling function takes an array of (buf_ptr, size) pairs and a type-field for each such pair.

Bitmask 0x10 seems to indicate null-terminated strings, but that flag is ignored by the marshalling code.

{| class="wikitable" border="1"
! Type Mask || Description
|-
| 4 + 1 || Creates an A descriptor
|-
| 4 + 2 || Creates a B descriptor
|-
| 8 + 1 || Creates an X descriptor
|-
| 8 + 2 || Creates a C descriptor
|-
| 0x20 + 1 || Creates both an A and X descriptor
|}

{| class="wikitable" border="1"
! Type || Description
|-
| 0x1A || Output-buf, copy?
|}

Services API

2017-05-10T10:48:26Z

GovanifY: (strings binary | grep SCFI) == false, SFCI == true

Services are system processes running in the background which wait for incoming requests. When a process wants to communicate with a service, it first needs to get a handle to the named service, and then it can communicate with the service via inter-process communication (each service has a name up to 8 characters).

Handles for services are retrieved from the service manager port, "sm:". Services are an abstraction of ports, they operate the same way except regular ports can have their handles retrieved directly from a SVC.

= sm: =
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#Initialize]]
|-
| 1 || [[#GetService]]
|-
| 2 || [[#RegisterService]]
|-
| 3 ||
|}

== Initialize ==
{| class="wikitable" border="1"
|-
! Word || Value
|-
| 0 || 0x00000004
|-
| 1 || 0x8000000A
|-
| 2 || 0x00000001
|- style="border-top: double"
| 0-1 || Pid
|- style="border-top: double"
| 0 || "SFCI"
|-
| 1 || 0x00000000
|-
| 2 || Always 0.
|}

== GetService ==
{| class="wikitable" border="1"
|-
! Word || Value
|-
| 0 || 0x00000004
|-
| 1 || 0x0000000A
|- style="border-top: double"
| 0 || "SFCI"
|-
| 1 || 0x00000001
|-
| 2 || Service name, zero padded and casted to u64.
|}

== RegisterService ==
{| class="wikitable" border="1"
|-
! Word || Value
|-
| 0 || 0x00000004
|-
| 1 || 0x0000000C
|- style="border-top: double"
| 0 || "SFCI"
|-
| 1 || 0x00000002
|-
| 2 || Service name, zero padded and casted to u64.
|-
| 3 || Max sessions? 32-bit integer.
|-
| 4 || Unknown bool
|}

= Service List =
{| class="wikitable" border="1"
|-
! Service names
! scope="col" width="200" | Description
! scope="col" width="200" | Notes
|-
| acc:u1, acc:su
| [[Account services]]
| u1: for user 1?
|-
| appletAE
| Applet Accessor services
|
|-
| aoc:u
| AddOn Content services
|
|-
| audren:u
| Audio Renderer services
|
|-
| audout:u
| Audio Out services
|
|-
| bgtc:t, bgtc:sc
| Task services
|
|-
| bsd:u, bsd:s
| Sockets services
|
|-
| caps:a, caps:c, caps:ss
| Capture services
| a: Album, ss: Screenshot
|-
| fatal:u
| Fatal Error services
|
|-
| friend:u, friend:v, friend:m, friend:s, friend:a
| Friend services
|
|-
| fsp-srv
| [[Filesystem services]]
|
|-
| hid, hid:dbg, hid:sys
| [[HID services]]
|
|-
| ldn:m
| [[Local Network Monitor services]]
|
|-
| ldr:ro, ldr:shel
| [[Loader services]]
|
|-
| lm
| Log services
|
|-
| lr
| ?
|
|-
| erpt:c
| ERPT(?) services
|
|-
| mii:u, mii:e
| Mii services
|
|-
| nifm:u, nifm:a, nifm:s
| Network Interface services
| u: User, a: Applet, s: System
|-
| nim:shp
| NIM services
| shp: eShop
|-
| ns:am, ns:su, ns:dev
| [[NS Services]]
| am: Application Manager, su: System Update
|-
| nsd:u, nsd:a
| [[NSD services]]
|
|-
| nvdrv:a, nvmemp, mm:u
| [[NV services]]
|
|-
| ovln:rcv, ovln:snd
| Overlay Notification services
|
|-
| pctl, pctl:a, pctl:s, pctl:r
| Parental Control services
|
|-
| pdm:ntfy, pdm:qry
| Play Log services
|
|-
| pl:u
| Shared Font services
|
|-
| pm:bm, pm:shell
| [[Process Manager services]]
|
|-
| prepo:u, prepo:s, prepo:m, prepo:a
| [[Play Report services]]
|
|-
| set, set:sys
| [[Settings services]]
| sys: System settings
|-
| sfdnsres
| DNS resolver services
|
|-
| ssl
| SSL services
|
|-
| time:u, time:a, time:s
| Time services
|
|-
| vi:m, vi:s, vi:u
| VI (Camera?) services
|
|}