xenia-rs/migration/project-root/ppc-manual/vmx/vpkswus.md

vpkswus — Vector Pack Signed Word Unsigned Saturate

Category: VMX (Altivec) · Form: VX · Opcode: 0x1000014e

Assembler Mnemonics

Mnemonic	XML entry	Flags	Description
vpkswus	vpkswus	—	Vector Pack Signed Word Unsigned Saturate
vpkswus128	vpkswus128	—	Vector128 Pack Signed Word Unsigned Saturate

Syntax

vpkswus [VD], [VA], [VB]
vpkswus128 [VD], [VA], [VB]

Encoding

vpkswus — form VX

• Opcode word: 0x1000014e
• Primary opcode (bits 0–5): 4
• Extended opcode: 334
• Synchronising: no

Bits	Field	Meaning
0–5	OPCD	primary opcode (4)
6–10	VRT/VD	destination vector register
11–15	VRA/VA	source A vector register
16–20	VRB/VB	source B vector register
21–31	XO	extended opcode (11 bits)

vpkswus128 — form VX128

• Opcode word: 0x140002c0
• Primary opcode (bits 0–5): 5
• Extended opcode: 704
• Synchronising: no

Bits	Field	Meaning
0–5	OPCD	primary opcode (4 or 5)
6–10	VD128l	destination low 5 bits
11–15	VA128l	source A low 5 bits
16–20	VB128l	source B low 5 bits
21	VA128H	source A high bit
22	—	reserved
23–25	VC	optional VC / XO sub-field
26	VA128h	source A middle bit
27	—	reserved
28–29	VD128h	destination high 2 bits
30–31	VB128h	source B high 2 bits

Operands

Field	Role	Description
VA	vpkswus: read; vpkswus128: read	Source A vector register.
VB	vpkswus: read; vpkswus128: read	Source B vector register.
VD	vpkswus: write; vpkswus128: write	Destination vector register.
VSCR	vpkswus: write; vpkswus128: write	Vector Status and Control Register (NJ/SAT bits).

Register Effects

vpkswus

• Reads (always): VA, VB
• Reads (conditional): none
• Writes (always): VD, VSCR
• Writes (conditional): none

vpkswus128

• Reads (always): VA, VB
• Reads (conditional): none
• Writes (always): VD, VSCR
• Writes (conditional): none

Status-Register Effects

• vpkswus: VSCR[SAT] may be stickied on saturating vector operations.
• vpkswus128: VSCR[SAT] may be stickied on saturating vector operations.

Operation (pseudocode)

; Pseudocode derives directly from the xenia-rs interpreter
; arm (see Implementation References). Operation semantics:
;   - Read source operands from the fields listed under Operands.
;   - Apply the arithmetic / logical / memory action described
;     in the Description field above.
;   - Write results to the destination register(s); update any
;     status bits enumerated under Status-Register Effects.
; Consult the IBM AIX reference link under IBM Reference for
; canonical PPC-style pseudocode where xenia's expression is
; terse.

C Translation Example

/* C translation: the xenia-rs interpreter arm below in           */
/* Implementation References is the authoritative semantic        */
/* snapshot. Translate it line-by-line:                            */
/*   - ctx.gpr[N]  -> r[N]       (or f[]/v[] for FPRs/VRs)        */
/*   - mem.read_u*/write_u* -> mem_read_u*_be / mem_write_u*_be   */
/*   - ctx.update_cr_signed(fld, v) -> update_cr_signed(fld, v)   */
/*   - ctx.xer_ca / xer_ov / xer_so -> xer.CA / xer.OV / xer.SO   */
/* The Register Effects and Status-Register Effects tables above  */
/* enumerate every side effect a faithful translation must emit.  */

Implementation References

vpkswus

• xenia-canary XML: tools/ppc-instructions.xml — search for mnem="vpkswus"
• xenia-canary emit: src/xenia/cpu/ppc/ppc_emit_altivec.cc:1889
• xenia-rs opcode: crates/xenia-cpu/src/opcode.rs:114
• xenia-rs decoder: crates/xenia-cpu/src/decoder.rs:465
• xenia-rs interpreter: crates/xenia-cpu/src/interpreter.rs:4096-4108

xenia-rs interpreter body (frozen snapshot)

        PpcOpcode::vpkswus | PpcOpcode::vpkswus128 => {
            let is_128 = matches!(instr.opcode, PpcOpcode::vpkswus128);
            let (ra, rb, rd) = if is_128 { (instr.va128(), instr.vb128(), instr.vd128()) }
                               else { (instr.ra(), instr.rb(), instr.rd()) };
            let a = crate::vmx::as_i32x4(ctx.vr[ra]);
            let b = crate::vmx::as_i32x4(ctx.vr[rb]);
            let mut r = [0u16; 8]; let mut sat = false;
            for i in 0..4 { let (v, s) = crate::vmx::sat_i32_to_u16(a[i]); r[i] = v; sat |= s; }
            for i in 0..4 { let (v, s) = crate::vmx::sat_i32_to_u16(b[i]); r[4 + i] = v; sat |= s; }
            if sat { ctx.set_vscr_sat(true); }
            ctx.vr[rd] = xenia_types::Vec128::from_u16x8_array(r);
            ctx.pc += 4;
        }

vpkswus128

• xenia-canary XML: tools/ppc-instructions.xml — search for mnem="vpkswus128"
• xenia-canary emit: src/xenia/cpu/ppc/ppc_emit_altivec.cc:1892
• xenia-rs opcode: crates/xenia-cpu/src/opcode.rs:114
• xenia-rs decoder: crates/xenia-cpu/src/decoder.rs:624
• xenia-rs interpreter: crates/xenia-cpu/src/interpreter.rs:4096-4108

xenia-rs interpreter body (frozen snapshot)

        PpcOpcode::vpkswus | PpcOpcode::vpkswus128 => {
            let is_128 = matches!(instr.opcode, PpcOpcode::vpkswus128);
            let (ra, rb, rd) = if is_128 { (instr.va128(), instr.vb128(), instr.vd128()) }
                               else { (instr.ra(), instr.rb(), instr.rd()) };
            let a = crate::vmx::as_i32x4(ctx.vr[ra]);
            let b = crate::vmx::as_i32x4(ctx.vr[rb]);
            let mut r = [0u16; 8]; let mut sat = false;
            for i in 0..4 { let (v, s) = crate::vmx::sat_i32_to_u16(a[i]); r[i] = v; sat |= s; }
            for i in 0..4 { let (v, s) = crate::vmx::sat_i32_to_u16(b[i]); r[4 + i] = v; sat |= s; }
            if sat { ctx.set_vscr_sat(true); }
            ctx.vr[rd] = xenia_types::Vec128::from_u16x8_array(r);
            ctx.pc += 4;
        }

Special Cases & Edge Conditions

• Signed word → unsigned half-word saturating pack. Each of the 8 input word lanes is interpreted as int32 and clamped to [0, 65535]. Negatives → 0, values above 65535 → 65535, sticky-setting VSCR[SAT].
• Lane-count doubling. 8 word lanes → 8 half-word lanes, ordered as VA then VB.
• Choose over vpkswss when negative results shouldn't survive — e.g. clamped colour or intensity values that happen to have arrived in int32 form.
• VSCR[SAT] is sticky.
• No Rc, no XER / FPSCR.
• VMX128 sibling vpkswus128.

Related Instructions

• vpkswss — signed → signed clamp.
• vpkuwus — unsigned word input → unsigned half-word.
• vpkuwum — modulo (truncate) pack.
• vpkshus — the half-word → byte analogue.
• vupkhsh, vupklsh — signed-half-word unpacks.

IBM Reference

• AIX 7.3 — vpkswus (Vector Pack Signed Word Unsigned Saturate)
• IBM AltiVec Technology Programmer's Interface Manual, Chapter 6 — Permute and Formatting