Eric Lee / smarc-uboot

Blame view

include/power-domain-uclass.h 2.36 KB
edit raw normal view history
83d290c56   Tom Rini   SPDX: Convert all... 
1
 
  /* SPDX-License-Identifier: GPL-2.0 */
61f5ddcb7   Stephen Warren   Add a power domai... 
2
3
 
  /*
   * Copyright (c) 2016, NVIDIA CORPORATION.
61f5ddcb7   Stephen Warren   Add a power domai... 
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
   */
  
  #ifndef _POWER_DOMAIN_UCLASS_H
  #define _POWER_DOMAIN_UCLASS_H
  
  /* See power-domain.h for background documentation. */
  
  #include <power-domain.h>
  
  struct udevice;
  
  /**
   * struct power_domain_ops - The functions that a power domain controller driver
   * must implement.
   */
  struct power_domain_ops {
  	/**
  	 * of_xlate - Translate a client's device-tree (OF) power domain
  	 * specifier.
  	 *
  	 * The power domain core calls this function as the first step in
  	 * implementing a client's power_domain_get() call.
  	 *
  	 * If this function pointer is set to NULL, the power domain core will
  	 * use a default implementation, which assumes #power-domain-cells =
  	 * <1>, and that the DT cell contains a simple integer power domain ID.
  	 *
  	 * At present, the power domain API solely supports device-tree. If
  	 * this changes, other xxx_xlate() functions may be added to support
  	 * those other mechanisms.
  	 *
  	 * @power_domain:	The power domain struct to hold the
  	 *			translation result.
  	 * @args:		The power domain specifier values from device
  	 *			tree.
  	 * @return 0 if OK, or a negative error code.
  	 */
  	int (*of_xlate)(struct power_domain *power_domain,
424b2fe93   Simon Glass   dm: power-domain:... 
42
 
  			struct ofnode_phandle_args *args);
61f5ddcb7   Stephen Warren   Add a power domai... 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
  	/**
  	 * request - Request a translated power domain.
  	 *
  	 * The power domain core calls this function as the second step in
  	 * implementing a client's power_domain_get() call, following a
  	 * successful xxx_xlate() call.
  	 *
  	 * @power_domain:	The power domain to request; this has been
  	 *			filled in by a previous xxx_xlate() function
  	 *			call.
  	 * @return 0 if OK, or a negative error code.
  	 */
  	int (*request)(struct power_domain *power_domain);
  	/**
4f51188e4   Simon Glass   power-domain: Ren... 
57
 
  	 * rfree - Free a previously requested power domain.
61f5ddcb7   Stephen Warren   Add a power domai... 
58
59
60
61
62
63
 
  	 *
  	 * This is the implementation of the client power_domain_free() API.
  	 *
  	 * @power_domain:	The power domain to free.
  	 * @return 0 if OK, or a negative error code.
  	 */
4f51188e4   Simon Glass   power-domain: Ren... 
64
 
  	int (*rfree)(struct power_domain *power_domain);
61f5ddcb7   Stephen Warren   Add a power domai... 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
  	/**
  	 * on - Power on a power domain.
  	 *
  	 * @power_domain:	The power domain to turn on.
  	 * @return 0 if OK, or a negative error code.
  	 */
  	int (*on)(struct power_domain *power_domain);
  	/**
  	 * off - Power off a power domain.
  	 *
  	 * @power_domain:	The power domain to turn off.
  	 * @return 0 if OK, or a negative error code.
  	 */
  	int (*off)(struct power_domain *power_domain);
  };
  
  #endif