1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * Copyright (C) 2012 Samsung Electronics. 4*4882a593Smuzhiyun * Kyungmin Park <kyungmin.park@samsung.com> 5*4882a593Smuzhiyun * Tomasz Figa <t.figa@samsung.com> 6*4882a593Smuzhiyun */ 7*4882a593Smuzhiyun 8*4882a593Smuzhiyun #ifndef __ASM_ARM_FIRMWARE_H 9*4882a593Smuzhiyun #define __ASM_ARM_FIRMWARE_H 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun #include <linux/bug.h> 12*4882a593Smuzhiyun 13*4882a593Smuzhiyun /* 14*4882a593Smuzhiyun * struct firmware_ops 15*4882a593Smuzhiyun * 16*4882a593Smuzhiyun * A structure to specify available firmware operations. 17*4882a593Smuzhiyun * 18*4882a593Smuzhiyun * A filled up structure can be registered with register_firmware_ops(). 19*4882a593Smuzhiyun */ 20*4882a593Smuzhiyun struct firmware_ops { 21*4882a593Smuzhiyun /* 22*4882a593Smuzhiyun * Inform the firmware we intend to enter CPU idle mode 23*4882a593Smuzhiyun */ 24*4882a593Smuzhiyun int (*prepare_idle)(unsigned long mode); 25*4882a593Smuzhiyun /* 26*4882a593Smuzhiyun * Enters CPU idle mode 27*4882a593Smuzhiyun */ 28*4882a593Smuzhiyun int (*do_idle)(unsigned long mode); 29*4882a593Smuzhiyun /* 30*4882a593Smuzhiyun * Sets boot address of specified physical CPU 31*4882a593Smuzhiyun */ 32*4882a593Smuzhiyun int (*set_cpu_boot_addr)(int cpu, unsigned long boot_addr); 33*4882a593Smuzhiyun /* 34*4882a593Smuzhiyun * Gets boot address of specified physical CPU 35*4882a593Smuzhiyun */ 36*4882a593Smuzhiyun int (*get_cpu_boot_addr)(int cpu, unsigned long *boot_addr); 37*4882a593Smuzhiyun /* 38*4882a593Smuzhiyun * Boots specified physical CPU 39*4882a593Smuzhiyun */ 40*4882a593Smuzhiyun int (*cpu_boot)(int cpu); 41*4882a593Smuzhiyun /* 42*4882a593Smuzhiyun * Initializes L2 cache 43*4882a593Smuzhiyun */ 44*4882a593Smuzhiyun int (*l2x0_init)(void); 45*4882a593Smuzhiyun /* 46*4882a593Smuzhiyun * Enter system-wide suspend. 47*4882a593Smuzhiyun */ 48*4882a593Smuzhiyun int (*suspend)(void); 49*4882a593Smuzhiyun /* 50*4882a593Smuzhiyun * Restore state of privileged hardware after system-wide suspend. 51*4882a593Smuzhiyun */ 52*4882a593Smuzhiyun int (*resume)(void); 53*4882a593Smuzhiyun }; 54*4882a593Smuzhiyun 55*4882a593Smuzhiyun /* Global pointer for current firmware_ops structure, can't be NULL. */ 56*4882a593Smuzhiyun extern const struct firmware_ops *firmware_ops; 57*4882a593Smuzhiyun 58*4882a593Smuzhiyun /* 59*4882a593Smuzhiyun * call_firmware_op(op, ...) 60*4882a593Smuzhiyun * 61*4882a593Smuzhiyun * Checks if firmware operation is present and calls it, 62*4882a593Smuzhiyun * otherwise returns -ENOSYS 63*4882a593Smuzhiyun */ 64*4882a593Smuzhiyun #define call_firmware_op(op, ...) \ 65*4882a593Smuzhiyun ((firmware_ops->op) ? firmware_ops->op(__VA_ARGS__) : (-ENOSYS)) 66*4882a593Smuzhiyun 67*4882a593Smuzhiyun /* 68*4882a593Smuzhiyun * register_firmware_ops(ops) 69*4882a593Smuzhiyun * 70*4882a593Smuzhiyun * A function to register platform firmware_ops struct. 71*4882a593Smuzhiyun */ register_firmware_ops(const struct firmware_ops * ops)72*4882a593Smuzhiyunstatic inline void register_firmware_ops(const struct firmware_ops *ops) 73*4882a593Smuzhiyun { 74*4882a593Smuzhiyun BUG_ON(!ops); 75*4882a593Smuzhiyun 76*4882a593Smuzhiyun firmware_ops = ops; 77*4882a593Smuzhiyun } 78*4882a593Smuzhiyun 79*4882a593Smuzhiyun #endif 80