rom_pwr_5410x.h 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. /*
  2. * @brief LPC5410X Power ROM API declarations and functions
  3. *
  4. * @note
  5. * Copyright(C) NXP Semiconductors, 2014
  6. * All rights reserved.
  7. *
  8. * @par
  9. * Software that is described herein is for illustrative purposes only
  10. * which provides customers with programming information regarding the
  11. * LPC products. This software is supplied "AS IS" without any warranties of
  12. * any kind, and NXP Semiconductors and its licensor disclaim any and
  13. * all warranties, express or implied, including all implied warranties of
  14. * merchantability, fitness for a particular purpose and non-infringement of
  15. * intellectual property rights. NXP Semiconductors assumes no responsibility
  16. * or liability for the use of the software, conveys no license or rights under any
  17. * patent, copyright, mask work right, or any other intellectual property rights in
  18. * or to any products. NXP Semiconductors reserves the right to make changes
  19. * in the software without notification. NXP Semiconductors also makes no
  20. * representation or warranty that such application will be suitable for the
  21. * specified use without further testing or modification.
  22. *
  23. * @par
  24. * Permission to use, copy, modify, and distribute this software and its
  25. * documentation is hereby granted, under NXP Semiconductors' and its
  26. * licensor's relevant copyrights in the software, without fee, provided that it
  27. * is used in conjunction with NXP Semiconductors microcontrollers. This
  28. * copyright, permission, and disclaimer notice must appear in all copies of
  29. * this code.
  30. */
  31. #ifndef __ROM_PWR_5410X_H_
  32. #define __ROM_PWR_5410X_H_
  33. #ifdef __cplusplus
  34. extern "C" {
  35. #endif
  36. /** @defgroup PWRD_5410X CHIP: LPC5410X Power ROM API declarations and functions
  37. * @ingroup ROMAPI_5410X
  38. * @{
  39. */
  40. /* 'mode' input values to set_voltage ROM function */
  41. typedef enum {
  42. POWER_LOW_POWER_MODE = 0,
  43. POWER_BALANCED_MODE,
  44. POWER_HIGH_PERFORMANCE
  45. } PERF_MODE_T;
  46. /* 'mode' input values to power_mode_configure ROM function */
  47. typedef enum {
  48. POWER_SLEEP = 0,
  49. POWER_DEEP_SLEEP,
  50. POWER_POWER_DOWN,
  51. POWER_DEEP_POWER_DOWN
  52. } POWER_MODE_T;
  53. /** @brief Power ROM indirect function structure
  54. * Do not use these functions as direct calls to ROM. Instead, use the
  55. * wrapper functions provided by the Power library (power_lib_5410x.h)
  56. */
  57. typedef struct {
  58. uint32_t (*set_pll)(uint32_t multiply_by, uint32_t input_freq);
  59. uint32_t (*set_voltage)(uint32_t mode, uint32_t desired_freq);
  60. void (*power_mode_configure)(uint32_t mode, uint32_t peripheral_ctrl);
  61. } PWRD_API_T;
  62. /**
  63. * @}
  64. */
  65. #ifdef __cplusplus
  66. }
  67. #endif
  68. #endif /* __ROM_PWR_5410X_H_ */