rkcommon.h 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * (C) Copyright 2015 Google, Inc
  4. * Written by Simon Glass <sjg@chromium.org>
  5. */
  6. #ifndef _RKCOMMON_H
  7. #define _RKCOMMON_H
  8. enum {
  9. RK_BLK_SIZE = 512,
  10. RK_SIZE_ALIGN = 2048,
  11. RK_INIT_OFFSET = 4,
  12. RK_MAX_BOOT_SIZE = 512 << 10,
  13. RK_SPL_HDR_START = RK_INIT_OFFSET * RK_BLK_SIZE,
  14. RK_SPL_HDR_SIZE = 4,
  15. };
  16. /**
  17. * rkcommon_check_params() - check params
  18. *
  19. * @return 0 if OK, -1 if ERROR.
  20. */
  21. int rkcommon_check_params(struct image_tool_params *params);
  22. /**
  23. * rkcommon_get_spl_hdr() - get 4-bytes spl hdr for a Rockchip boot image
  24. *
  25. * Rockchip's bootrom requires the spl loader to start with a 4-bytes
  26. * header. The content of this header depends on the chip type.
  27. */
  28. const char *rkcommon_get_spl_hdr(struct image_tool_params *params);
  29. /**
  30. * rkcommon_get_spl_size() - get spl size for a Rockchip boot image
  31. *
  32. * Different chip may have different sram size. And if we want to jump
  33. * back to the bootrom after spl, we may need to reserve some sram space
  34. * for the bootrom.
  35. * The spl loader size should be sram size minus reserved size(if needed)
  36. */
  37. int rkcommon_get_spl_size(struct image_tool_params *params);
  38. /**
  39. * rkcommon_set_header() - set up the header for a Rockchip boot image
  40. *
  41. * This sets up a 2KB header which can be interpreted by the Rockchip boot ROM.
  42. *
  43. * @buf: Pointer to header place (must be at least 2KB in size)
  44. */
  45. void rkcommon_set_header(void *buf, struct stat *sbuf, int ifd,
  46. struct image_tool_params *params);
  47. /**
  48. * rkcommon_verify_header() - verify the header for a Rockchip boot image
  49. *
  50. * @buf: Pointer to the image file
  51. * @file_size: Size of entire bootable image file (incl. all padding)
  52. * @return 0 if OK
  53. */
  54. int rkcommon_verify_header(unsigned char *buf, int size,
  55. struct image_tool_params *params);
  56. /**
  57. * rkcommon_print_header() - print the header for a Rockchip boot image
  58. *
  59. * This prints the header, spl_name and whether this is a SD/MMC or SPI image.
  60. *
  61. * @buf: Pointer to the image (can be a read-only file-mapping)
  62. */
  63. void rkcommon_print_header(const void *buf);
  64. /**
  65. * rkcommon_need_rc4_spl() - check if rc4 encoded spl is required
  66. *
  67. * Some socs cannot disable the rc4-encryption of the spl binary.
  68. * rc4 encryption is disabled normally except on socs that cannot
  69. * handle unencrypted binaries.
  70. * @return true or false depending on rc4 being required.
  71. */
  72. bool rkcommon_need_rc4_spl(struct image_tool_params *params);
  73. /**
  74. * rkcommon_rc4_encode_spl() - encode the spl binary
  75. *
  76. * Encrypts the SPL binary using the generic rc4 key as required
  77. * by some socs.
  78. *
  79. * @buf: Pointer to the SPL data (header and SPL binary)
  80. * @offset: offset inside buf to start at
  81. * @size: number of bytes to encode
  82. */
  83. void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size);
  84. /**
  85. * rkcommon_vrec_header() - allocate memory for the header
  86. *
  87. * @params: Pointer to the tool params structure
  88. * @tparams: Pointer tot the image type structure (for setting
  89. * the header and header_size)
  90. *
  91. * @return 0 (always)
  92. */
  93. int rkcommon_vrec_header(struct image_tool_params *params,
  94. struct image_type_params *tparams);
  95. #endif