kernel/dev/psci/include/dev/psci.h

// Copyright 2017 The Fuchsia Authors
// Copyright (c) 2016, Google, Inc. All rights reserved
//
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT

#pragma once

#include <arch.h>
#include <arch/arm64/mp.h>
#include <dev/power.h>

#define PSCI64_PSCI_VERSION                 (0x84000000)
#define PSCI64_CPU_SUSPEND                  (0xC4000001)
#define PSCI64_CPU_OFF                      (0x84000002)
#define PSCI64_CPU_ON                       (0xC4000003)
#define PSCI64_AFFINITY_INFO                (0xC4000004)
#define PSCI64_MIGRATE                      (0xC4000005)
#define PSCI64_MIGRATE_INFO_TYPE            (0x84000006)
#define PSCI64_MIGRATE_INFO_UP_CPU          (0xC4000007)
#define PSCI64_SYSTEM_OFF                   (0x84000008)
#define PSCI64_SYSTEM_RESET                 (0x84000009)
#define PSCI64_PSCI_FEATURES                (0x8400000A)
#define PSCI64_CPU_FREEZE                   (0x8400000B)
#define PSCI64_CPU_DEFAULT_SUSPEND          (0xC400000C)
#define PSCI64_NODE_HW_STATE                (0xC400000D)
#define PSCI64_SYSTEM_SUSPEND               (0xC400000E)
#define PSCI64_PSCI_SET_SUSPEND_MODE        (0x8400000F)
#define PSCI64_PSCI_STAT_RESIDENCY          (0xC4000010)
#define PSCI64_PSCI_STAT_COUNT              (0xC4000011)

#define PSCI_SUCCESS                        0
#define PSCI_NOT_SUPPORTED                  -1
#define PSCI_INVALID_PARAMETERS             -2
#define PSCI_DENIED                         -3
#define PSCI_ALREADY_ON                     -4
#define PSCI_ON_PENDING                     -5
#define PSCI_INTERNAL_FAILURE               -6
#define PSCI_NOT_PRESENT                    -7
#define PSCI_DISABLED                       -8
#define PSCI_INVALID_ADDRESS                -9

__BEGIN_CDECLS

/* TODO NOTE: - currently these routines assume cpu topologies that are described only in AFF0 and AFF1.
            If a system is architected such that AFF2 or AFF3 are non-zero then this code will need
            to be revisited
*/

typedef uint64_t (*psci_call_proc)(uint32_t function, uint64_t arg0, uint64_t arg1, uint64_t arg2);

extern psci_call_proc do_psci_call;

static inline uint32_t psci_get_version(void) {

    return (uint32_t)do_psci_call(PSCI64_PSCI_VERSION,0,0,0);
}

/* powers down the calling cpu - only returns if call fails */
static inline uint32_t psci_cpu_off(void) {

    return (uint32_t)do_psci_call(PSCI64_CPU_OFF,0,0,0);
}

static inline uint32_t psci_cpu_on(uint64_t mpid, paddr_t entry) {

    return (uint32_t)do_psci_call(PSCI64_CPU_ON, mpid, entry, 0);
}

static inline uint32_t psci_get_affinity_info(uint64_t cluster, uint64_t cpuid) {

    return (uint32_t)do_psci_call(PSCI64_AFFINITY_INFO, ARM64_MPID(cluster, cpuid), 0, 0);
}

void psci_system_off(void);

void psci_system_reset(enum reboot_flags flags);

__END_CDECLS