README 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. OPERATING SYSTEM SPECIFIC ARM NEON DETECTION
  2. --------------------------------------------
  3. Detection of the ability to exexcute ARM NEON on an ARM processor requires
  4. operating system support. (The information is not available in user mode.)
  5. HOW TO USE THIS
  6. ---------------
  7. This directory contains C code fragments that can be included in arm/arm_init.c
  8. by setting the macro PNG_ARM_NEON_FILE to the file name in "" or <> at build
  9. time. This setting is not recorded in pnglibconf.h and can be changed simply by
  10. rebuilding arm/arm_init.o with the required macro definition.
  11. For any of this code to be used the ARM NEON code must be enabled and run time
  12. checks must be supported. I.e.:
  13. #if PNG_ARM_NEON_OPT > 0
  14. #ifdef PNG_ARM_NEON_CHECK_SUPPORTED
  15. This is done in a 'configure' build by passing configure the argument:
  16. --enable-arm-neon=check
  17. Apart from the basic Linux implementation in contrib/arm-neon/linux.c this code
  18. is unsupported. That means that it is not even compiled on a regular basis and
  19. may be broken in any given minor release.
  20. FILE FORMAT
  21. -----------
  22. Each file documents its testing status as of the last time it was tested (which
  23. may have been a long time ago):
  24. STATUS: one of:
  25. SUPPORTED: This indicates that the file is included in the regularly
  26. performed test builds and bugs are fixed when discovered.
  27. COMPILED: This indicates that the code did compile at least once. See the
  28. more detailed description for the extent to which the result was
  29. successful.
  30. TESTED: This means the code was fully compiled into the libpng test programs
  31. and these were run at least once.
  32. BUG REPORTS: an email address to which to send reports of problems
  33. The file is a fragment of C code. It should not define any 'extern' symbols;
  34. everything should be static. It must define the function:
  35. static int png_have_neon(png_structp png_ptr);
  36. That function must return 1 if ARM NEON instructions are supported, 0 if not.
  37. It must not execute png_error unless it detects a bug. A png_error will prevent
  38. the reading of the PNG and in the future, writing too.
  39. BUG REPORTS
  40. -----------
  41. If you mail a bug report for any file that is not SUPPORTED there may only be
  42. limited response. Consider fixing it and sending a patch to fix the problem -
  43. this is more likely to result in action.
  44. CONTRIBUTIONS
  45. -------------
  46. You may send contributions of new implementations to
  47. [email protected]. Please write code in strict C90 C where
  48. possible. Obviously OS dependencies are to be expected. If you submit code you
  49. must have the authors permission and it must have a license that is acceptable
  50. to the current maintainer; in particular that license must permit modification
  51. and redistribution.
  52. Please try to make the contribution a single file and give the file a clear and
  53. unambiguous name that identifies the target OS. If multiple files really are
  54. required put them all in a sub-directory.
  55. You must also be prepared to handle bug reports from users of the code, either
  56. by joining the png-mng-implement mailing list or by providing an email for the
  57. "BUG REPORTS" entry or both. Please make sure that the header of the file
  58. contains the STATUS and BUG REPORTS fields as above.
  59. Please list the OS requirements as precisely as possible. Ideally you should
  60. also list the environment in which the code has been tested and certainly list
  61. any environments where you suspect it might not work.