Atmosphere/thermosphere/src/gicv2.h

/*
 * Copyright (c) 2019 Atmosphère-NX
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include "types.h"

#define GIC_IRQID_MAX                   1020
#define GIC_IRQID_SPURIOUS_GRPNEEDACK   (GIC_IRQID_MAX + 2)
#define GIC_IRQID_SPURIOUS              (GIC_IRQID_MAX + 3)
#define GICV_PRIO_LEVELS                32
#define GICV_IDLE_PRIORITY              0xF8 // sometimes 0xFF

typedef struct ArmGicV2Distributor {
    u32 ctlr;
    u32 typer;
    u32 iidr;
    u8 _0x0c[0x80 - 0x0C];
    // Note: in reality only 512 interrupts max. are defined (nor "reserved") on Gicv2
    u32 igroupr[1024 / 32];
    u32 isenabler[1024 / 32];
    u32 icenabler[1024 / 32];
    u32 ispendr[1024 / 32];
    u32 icpendr[1024 / 32];
    u32 isactiver[1024 / 32];
    u32 icactiver[1024 / 32];
    u8 ipriorityr[1024]; // can be accessed as u8 or u32
    u8 itargetsr[1024]; // can be accessed as u8 or u32
    u32 icfgr[1024 / 16];
    u8 impldef_d00[0xF00 - 0xD00];
    u32 sgir;
    u8 _0xf04[0xF10 - 0xF04];
    u8 cpendsgir[16];
    u8 spendsgir[16];
    u8 _0xf30[0xFE8 - 0xF30];
    u32 icpidr2;
    u8 _0xfec[0x1000 - 0xFEC];
} ArmGicV2Distributor;

typedef struct ArmGicV2Controller {
    u32 ctlr;
    u32 pmr;
    u32 bpr;
    u32 iar;
    u32 eoir;
    u32 rpr;
    u32 hppir;
    u32 abpr;
    u32 aiar;
    u32 aeoir;
    u32 ahppir;
    u8 _0x2c[0x40 - 0x2C];
    u8 impldef_40[0xD0 - 0x40];
    u32 apr[4];
    u32 nsapr[4];
    u8 _0xf0[0xFC - 0xF0];
    u32 iidr;
    u8 _0x100[0x1000 - 0x100];
    u32 dir;
    u8 _0x1004[0x2000 - 0x1004];
} ArmGicV2Controller;

typedef struct ArmGicV2HypervisorControlRegister {
    bool en         : 1;
    bool uie        : 1;
    bool lrenpie    : 1;
    bool npie       : 1;
    bool vgrp0eie   : 1;
    bool vgrp0die   : 1;
    bool vgrp1eie   : 1;
    bool vgrp1die   : 1;
    u32 _8          : 19;
    u32 eoiCount    : 5;
} ArmGicV2HypervisorControlRegister;

typedef struct ArmGicV2MaintenanceIntStatRegister {
    bool eoi    : 1;
    bool u      : 1;
    bool lrenp  : 1;
    bool np     : 1;
    bool vgrp0e : 1;
    bool vgrp0d : 1;
    bool vgrp1e : 1;
    bool vgrp1d : 1;
    u32 _8      : 24;
} ArmGicV2MaintenanceIntStatRegister;

typedef struct ArmGicV2ListRegister {
    u32 virtualId       : 10;
    u32 physicalId      : 10; // note: different encoding if hw = 0 (can't represent it in struct)
    u32 sbz2            : 3;
    u32 priority        : 5;
    bool pending        : 1;
    bool active         : 1;
    bool grp1           : 1;
    bool hw             : 1;
} ArmGicV2ListRegister;

typedef struct ArmGicV2VmControlRegister {
    bool enableGrp0     : 1;
    bool enableGrp1     : 1;
    bool ackCtl         : 1;
    bool fiqEn          : 1;
    bool cbpr           : 1;
    u32 _5              : 4;
    bool eoiMode        : 1;
    u32 _10             : 8;
    u32 abpr            : 3;
    u32 bpr             : 3;
    u32 _24             : 3;
    u32 pmr             : 5;
} ArmGicV2VmControlRegister;

typedef struct ArmGicV2VirtualInterfaceController {
    ArmGicV2HypervisorControlRegister hcr;
    u32 vtr;
    ArmGicV2VmControlRegister vmcr;
    u8 _0x0c[0x10 - 0xC];
    ArmGicV2MaintenanceIntStatRegister misr;
    u8 _0x14[0x20 - 0x14];
    u32 eisr0;
    u32 eisr1;
    u8 _0x28[0x30 - 0x28];
    u32 elsr0;
    u32 elsr1;
    u8 _0x38[0xF0 - 0x38];
    u32 apr;
    u8 _0xf4[0x100 - 0xF4];
    ArmGicV2ListRegister lr[64];
} ArmGicV2VirtualInterfaceController;


typedef struct ArmGicV2 {
    volatile ArmGicV2Distributor *gicd;
    volatile ArmGicV2Controller *gicc;
    volatile ArmGicV2VirtualInterfaceController *gich;
    volatile ArmGicV2Controller *gicv;
} ArmGicV2;