Blame view

Documentation/arm/firmware.rst 2.31 KB
dc7a12bdf   Mauro Carvalho Chehab   docs: arm: conver...
1
2
3
  ==========================================================================
  Interface for registering and calling firmware-specific operations for ARM
  ==========================================================================
7366b92a7   Tomasz Figa   ARM: Add interfac...
4
5
6
7
8
9
  Written by Tomasz Figa <t.figa@samsung.com>
  
  Some boards are running with secure firmware running in TrustZone secure
  world, which changes the way some things have to be initialized. This makes
  a need to provide an interface for such platforms to specify available firmware
  operations and call them when needed.
9c261f89a   Tomasz Figa   ARM: firmware: In...
10
11
  Firmware operations can be specified by filling in a struct firmware_ops
  with appropriate callbacks and then registering it with register_firmware_ops()
dc7a12bdf   Mauro Carvalho Chehab   docs: arm: conver...
12
  function::
7366b92a7   Tomasz Figa   ARM: Add interfac...
13
14
  
  	void register_firmware_ops(const struct firmware_ops *ops)
9c261f89a   Tomasz Figa   ARM: firmware: In...
15
16
  The ops pointer must be non-NULL. More information about struct firmware_ops
  and its members can be found in arch/arm/include/asm/firmware.h header.
7366b92a7   Tomasz Figa   ARM: Add interfac...
17
18
19
  
  There is a default, empty set of operations provided, so there is no need to
  set anything if platform does not require firmware operations.
dc7a12bdf   Mauro Carvalho Chehab   docs: arm: conver...
20
  To call a firmware operation, a helper macro is provided::
7366b92a7   Tomasz Figa   ARM: Add interfac...
21
22
23
24
25
26
27
  
  	#define call_firmware_op(op, ...)				\
  		((firmware_ops->op) ? firmware_ops->op(__VA_ARGS__) : (-ENOSYS))
  
  the macro checks if the operation is provided and calls it or otherwise returns
  -ENOSYS to signal that given operation is not available (for example, to allow
  fallback to legacy operation).
dc7a12bdf   Mauro Carvalho Chehab   docs: arm: conver...
28
  Example of registering firmware operations::
7366b92a7   Tomasz Figa   ARM: Add interfac...
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
  
  	/* board file */
  
  	static int platformX_do_idle(void)
  	{
  		/* tell platformX firmware to enter idle */
  		return 0;
  	}
  
  	static int platformX_cpu_boot(int i)
  	{
  		/* tell platformX firmware to boot CPU i */
  		return 0;
  	}
  
  	static const struct firmware_ops platformX_firmware_ops = {
  		.do_idle        = exynos_do_idle,
  		.cpu_boot       = exynos_cpu_boot,
  		/* other operations not available on platformX */
  	};
  
  	/* init_early callback of machine descriptor */
  	static void __init board_init_early(void)
  	{
  		register_firmware_ops(&platformX_firmware_ops);
  	}
dc7a12bdf   Mauro Carvalho Chehab   docs: arm: conver...
55
  Example of using a firmware operation::
7366b92a7   Tomasz Figa   ARM: Add interfac...
56
57
  
  	/* some platform code, e.g. SMP initialization */
7673f5b14   Geert Uytterhoeven   Documentation: ar...
58
  	__raw_writel(__pa_symbol(exynos4_secondary_startup),
7366b92a7   Tomasz Figa   ARM: Add interfac...
59
60
61
62
63
64
65
  		CPU1_BOOT_REG);
  
  	/* Call Exynos specific smc call */
  	if (call_firmware_op(cpu_boot, cpu) == -ENOSYS)
  		cpu_boot_legacy(...); /* Try legacy way */
  
  	gic_raise_softirq(cpumask_of(cpu), 1);