Commit Graph

32 Commits

Author SHA1 Message Date
PulkoMandy
d1ecc0955f sparc docs: write down some more useful things
These are better here than in my bash history...

Change-Id: Iab8940f4efed950e26a8bad29cb8954464270e8f
Reviewed-on: https://review.haiku-os.org/c/haiku/+/4645
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2021-10-22 20:23:01 +00:00
Adrien Destugues
a5061ecec5 Generate developer docs with Sphinx
An effort was started some time ago to consolidate all internal
documentation in the git tree. However, this was just an accumulation of
files in various formats without any strucutre or way to browse it,
which results in no one even knowing that we have docs here.

This converts most of the files to restructuredtext and uses Sphinx to
generate an HTML browsable user manual (with a table of content and a
first attempt to put things in a global hierarchy).

There are almost no changes to the documentation content in this commit
(some obviously obsolete things were removed). The plan is to get the
toolchain up and running to make these docs easily available, and only
then see about improving the content. We can migrate some things off the
wiki and website, and rework the table of contents to have some more
hierarchy levels because currently it's a bit messy.

Change-Id: I924ac9dc6e753887ab56f18a09bdb0a1e1793bfd
Reviewed-on: https://review.haiku-os.org/c/haiku/+/4370
Reviewed-by: Niels Sascha Reedijk <niels.reedijk@gmail.com>
2021-08-27 11:41:17 +00:00
Adrien Destugues
4dcdff4fe3 Update "boot process specs" documentation
Quite a lot has happened since this was initially written.

Change-Id: Iad68ea821733ab7489d2f9713857d2752b80356d
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3674
Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2021-01-27 19:51:07 +00:00
PulkoMandy
e3952a44cd sparc: notes on network booting 2020-03-16 09:53:14 +01:00
Alexander von Gluck IV
79310ea4e1 docs/develop: Add doc on debugging bootloaders with gef
Change-Id: Ib2d161adf75904f592286451279c77fb61ea52c2
2020-01-24 15:13:29 -06:00
PulkoMandy
56f9c76088 sparc: boot mmu support
Get enough of the mmu working to be able to allocate memory.

Unlike on PowerPC, we get both address and size as 64bit values. So
adjust of_region to allow this.

Also unlike the PPC port, we do not drive the hardware directly, instead we
rely on the openboot primitives to manage the translation table. This
allows staying independant of the hardware, which is a good idea at
least for the bootloader (we can do actual hardware things in the
kernel)

Change-Id: Ifa57619d3a09b8f707e1f8640d8b4f71bb717e2a
Reviewed-on: https://review.haiku-os.org/c/haiku/+/1482
Reviewed-by: Alex von Gluck IV <kallisti5@unixzen.com>
2020-01-18 03:32:29 +00:00
Adrien Destugues
6ca34a59b5 Add some notes on how to use PCI serial ports for serial debugging. 2020-01-05 10:42:37 +01:00
Adrien Destugues
a5483ebd76 sparc: add some development notes 2019-11-24 13:38:15 +01:00
PulkoMandy
c90c06ef59 sparc: documentation about the boot process and useful commands
I didn't do anything with sparc for a few weeks (you don't want this
machine running when temperatures already are over 30°...), and I wastd
some time finding back some of the useful information, such as commands
to boot and debug, load and execution address of the bootloader program,
etc. So let's keep these in the documentation directory.

Change-Id: I293e0eea3063d410d66f9b2397c2cf0bdbfc6753
Reviewed-on: https://review.haiku-os.org/c/1581
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2019-07-13 01:29:05 +00:00
Adrien Destugues
506f9764d4 Some notes about openboot.
As I keep looking for the commands to do anything...

Next step is to figure out network booting and set up an easy way to
test haiku_loader.
2019-05-19 14:31:21 +02:00
Augustin Cavalier
18a8edbf0e docs/develop: More reorganization.
* There is now a 'busses' folder, and the extant USB/SDHCI/Bluetooth/etc.
   docs now live in it, instead of various other places.
 * kernel/ports is now kernel/arch, like it is in src/system.
   SPARC documentation is now in there, too.
 * VM files (these are rather outdated) are now in kernel/vm.
 * SCSI ASC info removed, this is easily available online and
   it doesn't seem to be very relevant.
2019-03-30 18:00:46 -04:00
Adrien Destugues
8b6f4cb290 Update SDHCI and device driver docs
Change-Id: Ic64b501b7166dd718aaf12412833f912e23bc6bf
Reviewed-on: https://review.haiku-os.org/c/967
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2019-02-16 21:46:56 +00:00
Augustin Cavalier
f2015c2f81 boot/platform/cfe: Remove, unused.
All platforms it was theoretically useful for also have U-Boot.
OK'd by mmu_man.
2018-08-11 20:21:12 -04:00
krish_iyer
0ea0138965 SDHCI MMC Driver Documentation
Change-Id: I4bbe302fabd21133a9c03b9e48a407db8afbc70e
Reviewed-on: https://review.haiku-os.org/452
Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2018-08-10 12:08:35 +00:00
Augustin Cavalier
e81a954787 docs/develop: Mass directory restructure.
Now vaguely follows the tree structure of "src", with the exception of
directories that described subsystems spanning more than one "kit" or
"server" (e.g. "media", "midi", "bluetooth") -- these have been left as their
own top-level directory within docs/develop.
2018-01-10 16:12:14 -05:00
Jerome Duval
3ffd22ce6d usb_disk: base the error sense handling on a reference table.
* imported asc-num.txt as a reference, was used to generate the asc sense table.
* use the sense asc and key tables to know which action and status codes are
to be applied.
* tested with an hard disk and a dvd reader.
* these tables could be reused by the scsi_periph module.
2013-09-20 23:56:06 +02:00
Przemysław Buczkowski
46cf7a5a73 Fix typos: super block -> superblock (#8974)
Signed-off-by: Przemysław Buczkowski <przemub@yahoo.pl>
Signed-off-by: Matt Madia <mattmadia@gmail.com>
2012-12-09 08:47:46 -05:00
Ingo Weinhold
c909ca65bf Patch by Zhao Shuai: Updated documentation regarding the use of the
radix tree.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27356 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-09-07 13:58:49 +00:00
Ingo Weinhold
9837b719af Some documentation on swap file support by Zhao Shuai.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27203 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-08-25 22:09:45 +00:00
Axel Dörfler
d11a6916ee More or less completed the introduction. I would just want to add the image,
and publish it on the website - comments are still welcome, though.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@25802 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-06-04 11:40:00 +00:00
Axel Dörfler
30f7fc408b An early version of an introduction to the new device manager. Will be expanded
more over the following days, and published on the website.
Comments welcome!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@25760 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-06-02 15:45:22 +00:00
Axel Dörfler
3721f6df39 Minor update; even though the TODO file isn't that long anymore, it doesn't
hurt to have it in the repository.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22990 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-11-24 15:43:46 +00:00
Axel Dörfler
a492532bd9 Get rid of outdated and mostly useless docs, updated some of the comments in the source.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21529 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-30 13:58:41 +00:00
Axel Dörfler
88799a5d97 An almost complete overview over the VM locking/reference count methods and their inherent problems.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21528 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-30 13:49:31 +00:00
Axel Dörfler
24cea645f1 Moved all documentation out of the device_manager.h header file to this place.
We might want to use it as a basis for the device manager documentation.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@12634 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-05-11 16:40:13 +00:00
Niels Sascha Reedijk
6256385fde *** empty log message ***
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@11251 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-02-04 21:23:13 +00:00
Niels Sascha Reedijk
365d034c1e Update the doc to confirm better to my plan.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@5226 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-11-01 12:20:43 +00:00
Niels Sascha Reedijk
a82ea040d1 Did some more designing:
- Borrowed the UHCI basic theory of operation from the freebsd handbook
- Started some work on the internals of devices


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4279 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-08-14 17:58:13 +00:00
Niels Sascha Reedijk
1501c2bf3e This is just an outline of the USB stack: what it is going to look like. It is definately not
ready for testing. Also the documentation is far from complete (it's in it's early phases).
Unfortunately I don't have enough experience in hardware programming to prototype
it first, so I'll be testing the things that I design in the document.


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4275 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-08-12 20:36:24 +00:00
Axel Dörfler
a019a926d7 Added the specification documentation of the node monitoring implementation.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2492 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-01-18 20:05:19 +00:00
Axel Dörfler
bb5a5c05ec Added a document describing/specifying the (future) boot process for
OpenBeOS on x86 systems.


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2079 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-11-25 13:58:24 +00:00
ejakowatz
52a3801208 It is accomplished ...
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@10 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-07-09 12:24:59 +00:00