35c02584efa56c95fb0337a05db97331843efcf9
[bootloader-ap.git] / README
1 bootloader-ap (Boot Loader for Application Processors)
2
3 Developed by TJ <linux@tjworld.net>
4 Copyright (C) 2010-
5
6 A GPLv3 licensed boot-loader for ARM-based communications devices based on modern System-on-Chip 
7 architectures such as the Qualcomm MSM7x30, which is the first target of this implementation.
8
9 The intention is to provide a completely Free and Open Source boot-loader that can be utilised by 
10 system manufacturers and user's who prefer to install a custom boot-loader.
11
12 Inspired by the HTC Vision device, known as the HTC Desire Z and T-Mobile G2. This device was locked 
13 by HTC to prevent easy customisation.
14
15 = Developer Notes =
16
17 Gathering the chip-set specifications for some parts of this code can be challenging. Prudent use of
18 a search engine can uncover many fragments of open-source code patches to many Linux kernel projects
19 for embedded devices.
20
21 To guard against any possible challenge as to the source of specifications and settings that
22 aren't publicly released by chip-set or device manufacturers there is a comment template to prefix
23 to any code that describes or uses those specifications or settings. Here's an example:
24
25 /*
26   SOURCE: HTC Vision Linux kernel 2.6.32 source
27   SOURCE_FILE: arch/arm/mach-msm/arch-init-7x30.S
28   SOURCE_URL: http://dl3.htc.com/RomCode/Source_and_Binaries/vision-2.6.32-g814e0a1.tar.gz
29   SOURCE_FOR: MSM7x30 equates, status-codes, IOMEM addresses, CP15 functions
30 */
31
32 ... some code
33
34 /* SOURCE_END */
35
36 By using pseudo-defines (SOURCE, SOURCE_*, SOURCE_END) inside a C-style comment block (/* ... */) it
37 makes it possible to use an automated tool to gather and document all sources of specifications and 
38 settings.