Documentation/scsi/arcmsr_spec.rst

Source file repositories/reference/linux-study-clean/Documentation/scsi/arcmsr_spec.rst

File Facts

System: Linux kernel
Corpus path: Documentation/scsi/arcmsr_spec.rst
Extension: .rst
Size: 25978 bytes
Lines: 909
Domain: Support Tooling And Documentation
Bucket: Documentation
Inferred role: Support Tooling And Documentation: documentation
Status: atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.
Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

No C-style include directives detected by the generator.

Detected Declarations

No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

===================
ARECA FIRMWARE SPEC
===================

Usage of IOP331 adapter
=======================

(All In/Out is in IOP331's view)

1. Message 0
------------

- InitThread message and return code

2. Doorbell is used for RS-232 emulation
----------------------------------------

inDoorBell
    bit0
	data in ready
	zDRIVER DATA WRITE OK)
    bit1
	data out has been read
	(DRIVER DATA READ OK)

outDooeBell:
    bit0
	data out ready
	(IOP331 DATA WRITE OK)
    bit1
	data in has been read
	(IOP331 DATA READ OK)

3. Index Memory Usage
---------------------

============   ==========================================
offset 0xf00   for RS232 out (request buffer)
offset 0xe00   for RS232 in  (scratch buffer)
offset 0xa00   for inbound message code message_rwbuffer
	       (driver send to IOP331)
offset 0xa00   for outbound message code message_rwbuffer
	       (IOP331 send to driver)
============   ==========================================

4. RS-232 emulation
-------------------

Currently 128 byte buffer is used:

============   =====================
1st uint32_t   Data length (1--124)
Byte 4--127    Max 124 bytes of data
============   =====================

5. PostQ
--------

All SCSI Command must be sent through postQ:

    (inbound queue port)
	Request frame must be 32 bytes aligned:

	    #bit27--bit31
		flag for post ccb
	    #bit0--bit26
		real address (bit27--bit31) of post arcmsr_cdb

		=====   ===================
		bit31   ==  ===============

Annotation

Atlas domain: Support Tooling And Documentation / Documentation.
Implementation status: atlas-only.

Implementation Notes

This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.