CeylanIPCCommands.h File Reference
#include "CeylanARM7Codes.h"
Go to the source code of this file.
Typedefs | |
| typedef FIFOCommandID | ARM9CommandID |
| This include file centralizes the system (Ceylan-specific) command identifiers for the FIFO-based IPC, notably for the Nintendo DS. | |
| typedef FIFOCommandID | ARM7CommandID |
| Identifiers for commands originating from the ARM7 (aimed at the ARM9):. | |
Variables | |
| CEYLAN_DLL const ARM9CommandID | HelloToTheARM7 |
| This is not really a command, as null values can occur before the FIFO system is up and running on both sides. | |
| CEYLAN_DLL const ARM9CommandID | PingARM7 |
| Sends a ping to the ARM7, which is expected to return a pong command. | |
| CEYLAN_DLL const ARM9CommandID | StatusInitRequest |
| Tells the ARM7 to update its state, and to write it and its error code in the variable whose address is specified in the next element of this command. | |
| CEYLAN_DLL const ARM9CommandID | ShutdownIPCRequest |
| Tells the ARM7 to stop its FIFO and its report mechanism. | |
| CEYLAN_DLL const ARM9CommandID | BatteryStatusRequest |
| Tells the ARM7 to send back the current battery status. | |
| CEYLAN_DLL const ARM9CommandID | DSTypeRequest |
| Tells the ARM7 to send back the actual DS type. | |
| CEYLAN_DLL const ARM7CommandID | HelloToTheARM9 |
| This is not really a command, as null values can occur before the FIFO system is up and running on both sides. | |
| CEYLAN_DLL const ARM7CommandID | PongARM9 |
| Sends a pong to the ARM9, after a ping command has been sent to the ARM7. | |
| CEYLAN_DLL const ARM7CommandID | BatteryStatusAnswer |
| Used by the ARM7 to return the current battery status. | |
| CEYLAN_DLL const ARM7CommandID | DSTypeAnswer |
| Used by the ARM7 to return the DS type. | |
Typedef Documentation
| typedef FIFOCommandID ARM7CommandID |
Identifiers for commands originating from the ARM7 (aimed at the ARM9):.
Definition at line 159 of file CeylanIPCCommands.h.
| typedef FIFOCommandID ARM9CommandID |
This include file centralizes the system (Ceylan-specific) command identifiers for the FIFO-based IPC, notably for the Nintendo DS.
It is to be included by ARM7 C code and ARM9 C++ code.
typedef for FIFOCommandID is expected to be already defined (it cannot be defined here as its definition is specific to each ARM: Ceylan::Uint8/uint8).
enum not used as are int, thus 32-bit, whereas we want 8 bit. System-specific command identifier values range from 0 to 127.
- Note:
- Ceylan subdivided this range into [0..32], reserved for its own use, and [32..127], reserved for Ceylan-integrating libraries, notably OSDL, which reserved [32..96].
Definition at line 67 of file CeylanIPCCommands.h.
Variable Documentation
| CEYLAN_DLL const ARM7CommandID BatteryStatusAnswer |
Used by the ARM7 to return the current battery status.
- See also:
- BatteryStatusRequest
Definition at line 75 of file CeylanIPCCommands.c.
Referenced by handleBatteryStatusRequest(), and Ceylan::System::FIFO::handleReceivedSystemSpecificCommand().
| CEYLAN_DLL const ARM9CommandID BatteryStatusRequest |
Tells the ARM7 to send back the current battery status.
No parameters set in the command element, no next element to send, but an answer is expected.
- See also:
- BatteryStatusAnswer
Definition at line 65 of file CeylanIPCCommands.c.
Referenced by handleReceivedSystemSpecificCommand(), and Ceylan::System::FIFO::sendBatteryStatusRequest().
| CEYLAN_DLL const ARM7CommandID DSTypeAnswer |
Used by the ARM7 to return the DS type.
- See also:
- DSTypeRequest
Definition at line 76 of file CeylanIPCCommands.c.
Referenced by handleDSTypeRequest(), and Ceylan::System::FIFO::handleReceivedSystemSpecificCommand().
| CEYLAN_DLL const ARM9CommandID DSTypeRequest |
Tells the ARM7 to send back the actual DS type.
No parameters set in the command element, no next element to send, but an answer is expected.
- See also:
- DSTypeAnswer
Definition at line 66 of file CeylanIPCCommands.c.
Referenced by handleReceivedSystemSpecificCommand(), and Ceylan::System::FIFO::sendDSTypeRequest().
| CEYLAN_DLL const ARM9CommandID HelloToTheARM7 |
This is not really a command, as null values can occur before the FIFO system is up and running on both sides.
No parameters set in the command element, no answer expected.
This is not really a command, as null values can occur before the FIFO system is up and running on both sides.
It is to be included by ARM7 C code and ARM9 C++ code.
typedef for FIFOCommandID is expected to be already defined (it cannot be defined here as its definition is specific to each ARM: Ceylan::Uint8/uint8).
enum not used as are int, thus 32-bit, whereas we want 8 bit. System-specific command identifier values range from 0 to 127.
- Note:
- Ceylan subdivided this range into [0..32], reserved for its own use, and [32..127], reserved for Ceylan-integrating libraries, notably OSDL, which reserved [32..96].
Definition at line 61 of file CeylanIPCCommands.c.
Referenced by handleReceivedSystemSpecificCommand().
| CEYLAN_DLL const ARM7CommandID HelloToTheARM9 |
This is not really a command, as null values can occur before the FIFO system is up and running on both sides.
No parameters set in the command element, no answer expected.
Definition at line 73 of file CeylanIPCCommands.c.
Referenced by Ceylan::System::FIFO::handleReceivedSystemSpecificCommand().
| CEYLAN_DLL const ARM9CommandID PingARM7 |
Sends a ping to the ARM7, which is expected to return a pong command.
No parameters set in the only command element, pong answer expected.
- See also:
- PongARM9
Definition at line 62 of file CeylanIPCCommands.c.
| CEYLAN_DLL const ARM7CommandID PongARM9 |
Sends a pong to the ARM9, after a ping command has been sent to the ARM7.
No parameters set in the only command element, no answer expected.
- See also:
- PingARM7
Definition at line 74 of file CeylanIPCCommands.c.
Referenced by Ceylan::System::FIFO::handleReceivedSystemSpecificCommand().
| CEYLAN_DLL const ARM9CommandID ShutdownIPCRequest |
Tells the ARM7 to stop its FIFO and its report mechanism.
No parameters set in the command element, no next element to send, no answer expected.
Definition at line 64 of file CeylanIPCCommands.c.
Referenced by Ceylan::System::FIFO::deactivate(), and handleReceivedSystemSpecificCommand().
| CEYLAN_DLL const ARM9CommandID StatusInitRequest |
Tells the ARM7 to update its state, and to write it and its error code in the variable whose address is specified in the next element of this command.
No parameters set in the command element, next sent element will be the address in question, no answer expected.
Definition at line 63 of file CeylanIPCCommands.c.
Referenced by Ceylan::System::FIFO::activate(), and handleReceivedSystemSpecificCommand().
