smpc.h

Go to the documentation of this file.

/*
** Jo Sega Saturn Engine
** Copyright (c) 2012-2026, Johannes Fetz (johannesfetz@gmail.com)
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are met:
**     * Redistributions of source code must retain the above copyright
**       notice, this list of conditions and the following disclaimer.
**     * Redistributions in binary form must reproduce the above copyright
**       notice, this list of conditions and the following disclaimer in the
**       documentation and/or other materials provided with the distribution.
**     * Neither the name of the Johannes Fetz nor the
**       names of its contributors may be used to endorse or promote products
**       derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
** DISCLAIMED. IN NO EVENT SHALL Johannes Fetz BE LIABLE FOR ANY
** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef __JO_SMPC_H__
# define __JO_SMPC_H__

typedef enum
{
    EnableMasterCPU = 0x0,
    EnableSlaveCPU = 0x2,
    DisableSlaveCPU = 0x3,
    EnableSoundCPU = 0x6,
    DisableSoundCPU = 0x7,
    EnableCD = 0x8,
    DisableCD = 0x9,
    EnableNetlink = 0xA,
    DisableNetlink = 0xB,
    SystemReset = 0xD,
    ChangeSystemClockSpeed352 = 0xE,
    ChangeSystemClockSpeed320 = 0xF,
    FetchStatusAndPeripheralData = 0x10,
    SetRTCDateAndTime = 0x16,
    SetSMPCMemory = 0x17,
    SendNMIRequestToMasterCPU = 0x18,
    EnableReset = 0x19,
    DisableReset = 0x1A
}               jo_smpc_command;
 
typedef enum
{
    CommandRegister = 0x2010001f,
    StatusRegister = 0x20100061,
    StatusFlag = 0x20100063,
    InputRegister0 = 0x20100001,
    InputRegister1 = 0x20100003,
    InputRegister2 = 0x20100005,
    InputRegister3 = 0x20100007,
    InputRegister4 = 0x20100009,
    InputRegister5 = 0x2010000b,
    InputRegister6 = 0x2010000d,
    OutputRegister0 = 0x20100021,
    OutputRegister1 = 0x20100023,
    OutputRegister2 = 0x20100025,
    OutputRegister3 = 0x20100027,
    OutputRegister4 = 0x20100029,
    OutputRegister5 = 0x2010002b,
    OutputRegister6 = 0x2010002d,
    OutputRegister7 = 0x2010002f,
    OutputRegister8 = 0x20100031,
    OutputRegister9 = 0x20100033,
    OutputRegister10 = 0x20100035,
    OutputRegister11 = 0x20100037,
    OutputRegister12 = 0x20100039,
    OutputRegister13 = 0x2010003b,
    OutputRegister14 = 0x2010003d,
    OutputRegister15 = 0x2010003f,
    OutputRegister16 = 0x20100041,
    OutputRegister17 = 0x20100043,
    OutputRegister18 = 0x20100045,
    OutputRegister19 = 0x20100047,
    OutputRegister20 = 0x20100049,
    OutputRegister21 = 0x2010004b,
    OutputRegister22 = 0x2010004d,
    OutputRegister23 = 0x2010004f,
    OutputRegister24 = 0x20100051,
    OutputRegister25 = 0x20100053,
    OutputRegister26 = 0x20100055,
    OutputRegister27 = 0x20100057,
    OutputRegister28 = 0x20100059,
    OutputRegister29 = 0x2010005b,
    OutputRegister30 = 0x2010005d,
    OutputRegister31 = 0x2010005f,
    PortDataRegister1 = 0x20100075,
    PortDataRegister2 = 0x20100077,
    DataDirectionRegister1 = 0x20100079,
    DataDirectionRegister2 = 0x2010007b,
    InputOutputSelectRegister = 0x2010007d,
    ExternalLatchEnableRegister = 0x2010007f
}               jo_smpc_memory_address;
 
static  __jo_force_inline void jo_smpc_write_byte(jo_smpc_memory_address addr, unsigned char data)
{
    (*(volatile unsigned char *)(addr)) = data;
}
static  __jo_force_inline unsigned char jo_smpc_read_byte(jo_smpc_memory_address addr)
{
    return (*(volatile unsigned char *)(addr));
}
static  __jo_force_inline void jo_smpc_wait(void)
{
    while ((jo_smpc_read_byte(StatusFlag) & 0x1) == 0x1);
}
static  __jo_force_inline void jo_smpc_begin_command(void)
{
    jo_smpc_wait();
    jo_smpc_write_byte(StatusFlag, 1);
}
static  __jo_force_inline void jo_smpc_end_command(jo_smpc_command command)
{
    jo_smpc_write_byte(CommandRegister, command);
    jo_smpc_wait();
}
 
/*
** PERIPHERALS
*/

# define JO_PERIPHERAL_ID_NOT_CONNECTED         (0xff)
# define JO_PERIPHERAL_ID_STANDARD_PAD          (0x02)
# define JO_PERIPHERAL_ID_RACING_WHEEL          (0x13)
# define JO_PERIPHERAL_ID_MISSION_STICK         (0x15)
# define JO_PERIPHERAL_ID_NIGHTS_PAD            (0x16)
# define JO_PERIPHERAL_ID_MOUSE                 (0x23)
# define JO_PERIPHERAL_ID_SHUTTLE_MOUSE         (0xe3)
# define JO_PERIPHERAL_ID_KEYBOARD              (0x34)

# define JO_PERIPHERAL_KEYBOARD_CAPS_LOCK       (1 << 6)
# define JO_PERIPHERAL_KEYBOARD_NUM_LOCK        (1 << 5)
# define JO_PERIPHERAL_KEYBOARD_SCROLL_LOCK     (1 << 4)
# define JO_PERIPHERAL_KEYBOARD_MAKE            (1 << 3)
# define JO_PERIPHERAL_KEYBOARD_BREAK           (1 << 0)

typedef struct
{
    unsigned char       id;         // JO_PERIPHERAL_ID_xxx
    unsigned char       size;       // Data size
    unsigned short      data;       // Current state
    unsigned short      push;       // Pressed this frame
    unsigned short      pull;       // Released this frame
    unsigned int        reserved[4];
}                       jo_peripheral;

typedef struct
{
    unsigned char       id;
    unsigned char       size;
    unsigned short      data;
    unsigned short      push;
    unsigned short      pull;
    unsigned char       x;
    unsigned char       y;
    unsigned char       z;
    unsigned char       w;
    unsigned int        reserved[3];
}                       jo_peripheral_analog;

typedef struct
{
    unsigned char       id;
    unsigned char       size;
    unsigned short      data;
    unsigned short      push;
    unsigned short      pull;
    short               x;
    short               y;
    unsigned int        reserved[3];
}                       jo_peripheral_pointer;

typedef struct
{
    unsigned char       id;
    unsigned char       size;
    unsigned short      data;
    unsigned short      push;
    unsigned short      pull;
    unsigned char       condition;  // JO_PERIPHERAL_KEYBOARD_xxx flags
    unsigned char       code;       // Key code
    unsigned short      reserved1;
    unsigned int        reserved2[3];
}                       jo_peripheral_keyboard;

# define JO_SMPC_PERIPHERAL_PER_PORT    (15)

extern jo_peripheral    __jo_smpc_peripherals[JO_SMPC_PERIPHERAL_PER_PORT * 2];

typedef struct
{
    unsigned char       cond;
    unsigned short      year;       // BCD
    unsigned char       month;      // week << 4 | month
    unsigned char       day;        // BCD
    unsigned char       hour;       // BCD
    unsigned char       minute;     // BCD
    unsigned char       second;     // BCD
    unsigned char       cartridge_code;
    unsigned char       area_code;
    unsigned short      system_status;
    unsigned int        smpc_memory;
}                       jo_smpc_status;

extern jo_smpc_status   __jo_smpc_status;

void                    __jo_smpc_command(const jo_smpc_command command);
 
#endif /* !__JO_SMPC_H__ */
 
/*
** END OF FILE
*/