Read about our upcoming Code of Conduct on this issue

This instance will be upgraded to Heptapod 0.28.0 on 2022-01-18 at 14:00 UTC+1 (a few minutes of down time)

Commit eb924eb1 authored by a1ex's avatar a1ex
Browse files

Doc update for the unified branch

--HG--
branch : unified
parent 4bbf8f6c8b83
.. raw:: latex
{ \small
Magic Lantern is an open (GPL) framework for developing enhancements to the amazing Canon 5D Mark II and 550D/T2i digital SLRs.
Magic Lantern is being `developed <http://groups.google.com/group/ml-devel>`_ by a small team, helped by a very enthusiastic and respectful `user community <http://vimeo.com/groups/magiclantern>`_.
**Initial version by** `Trammell Hudson <http://magiclantern.wikia.com/wiki/User:Autopilot>`_ (the author and lead of Magic Lantern project)
**Initial version by** `Trammell Hudson <http://magiclantern.wikia.com/wiki/User:Autopilot>`_ (original author and lead of Magic Lantern project)
**Crypto tools and firmware analysis by**
`Arm.Indy <http://magiclantern.wikia.com/wiki/User:Arm.indy>`_,
`AJ <http://magiclantern.wikia.com/wiki/2.0.4_AJ>`_
**Main developer for 550D branch:**
**Main developer for 550D and 60D cameras:**
`Alex <http://magiclantern.wikia.com/wiki/User:Alexdu>`_
**Crypto tools and 550D/1.0.9 port by**
**550D/1.0.9 port by**
`Arm.Indy <http://magiclantern.wikia.com/wiki/User:Arm.indy>`_
**Code review and insights by**
`AJ <http://magiclantern.wikia.com/wiki/2.0.4_AJ>`_
**60D port by**
`Arm.Indy <http://magiclantern.wikia.com/wiki/User:Arm.indy>`_,
`Jason <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=jason&qt_g=Search+this+group>`_,
`xaos <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=xaos&qt_g=Search+this+group>`_,
`SztupY <http://sztupy.hu/magiclantern/>`_,
`Alex <http://magiclantern.wikia.com/wiki/User:Alexdu>`_
**600D port by**
`Arm.Indy <http://magiclantern.wikia.com/wiki/User:Arm.indy>`_,
`Vincent Olivier <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=Vincent Olivier&qt_g=Search+this+group>`_,
`Alex <http://magiclantern.wikia.com/wiki/User:Alexdu>`_
**500D port by**
`Chuchin <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=Chuchin&qt_g=Search+this+group>`_,
`AlinS <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=Alin Simionoiu&qt_g=Search+this+group>`_,
`Coutts <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=Coutts&qt_g=Search+this+group>`_
**Patches by**
`piersg <http://pdaddy.wordpress.com/2010/11/07/quick-notes-on-magic-lantern-for-550d/>`_,
......@@ -19,7 +41,14 @@ Magic Lantern is being `developed <http://groups.google.com/group/ml-devel>`_ by
`trho <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=tobias&qt_g=Search+this+group>`_,
`deti <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=deti&qt_g=Search+this+group>`_,
`tapani <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=tapani&qt_g=Search+this+group>`_,
`phil <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=phil&qt_g=Search+this+group>`_
`phil <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=phil&qt_g=Search+this+group>`_,
`RoaldFre <http://magiclantern.wikia.com/wiki/User:RoaldFre>`_,
`Colin Peart <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=colin+peart&qt_g=Search+this+group>`_,
`cpc <http://www.cinema5d.com/viewtopic.php?f=30&t=24384&p=166944&hilit=waveform#p166944>`_,
`msi <http://forum.slashcam.de/11-vt86738.html?postdays=0&postorder=asc&&start=350>`_,
`robotsound <http://www.dvxuser.com/V6/showthread.php?218686-Magic-Lantern-for-550D-in-progress!/page117>`_,
`maclema <https://bitbucket.org/maclema/ml500d/overview>`_,
`adijiwa <https://bitbucket.org/adijiwa/magic-lantern-for-500d-local-hacks/>`_
**Card tools by**
`Pel <http://pel.hu>`_,
......@@ -30,22 +59,36 @@ Magic Lantern is being `developed <http://groups.google.com/group/ml-devel>`_ by
`CameraRick <http://magiclantern.wikia.com/wiki/User:CameraRick>`_,
`Robert <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=robert&qt_g=Search+this+group>`_,
`bwwd <http://www.dvxuser.com/V6/member.php?42938-bwwd>`_,
`turbinicarpus <http://www.canonistas.com/foros/members/turbinicarpus-61719.html>`_
`turbinicarpus <http://www.canonistas.com/foros/members/turbinicarpus-61719.html>`_,
`Dremelv21 <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=Dremelv21&qt_g=Search+this+group>`_,
`similaar <http://www.similaar.com/foto/cropmarks/mlcropmarks.html>`_
**Tutorials by**
`sawomedia <http://vimeo.com/sawo>`_,
`Renny <http://vimeo.com/renny>`_,
`Chung Dha <http://www.youtube.com/user/chungdha>`_,
`Dave Dugdale <http://www.learningdslrvideo.com/category/video-tutorials/>`_,
`Malcolm Debono <http://vimeo.com/user4129652>`_
`MediaUnlocked <http://www.youtube.com/user/MediaUnlocked>`_,
`Jeremy <http://vimeo.com/l33t>`_,
`Lauren Stevens <http://vimeo.com/22818564>`_,
`Shayne35mm <http://www.youtube.com/watch?v=ugyeulukDfY>`_,
`Mordy Gilden <http://vimeo.com/groups/magiclantern/videos/20546775>`_,
`Ryan Sauvé <http://www.vimeo.com/18507408>`_,
`Renny Hayes <http://vimeo.com/renny>`_,
`Daniel <http://vimeo.com/gefilmt>`_,
`Dod3032 <http://www.youtube.com/user/Dod3032>`_,
`MediaUnlocked <http://www.youtube.com/user/MediaUnlocked>`_,
`3615geek <http://vimeo.com/user5714625>`_,
`CineDigital.tv <http://www.cinedigital.tv/>`_,
`jeveuxdoncjevilme <http://www.jeveuxdoncjefilme.fr/>`_
Thanks to all the users who `provided feedback <http://groups.google.com/group/ml-devel>`_ and `reported bugs <http://bitbucket.org/hudson/magic-lantern/issues>`_!
**Magic Lantern logo by**
`Joseph <http://groups.google.com/group/ml-devel/search?group=ml-devel&q=eljoseph&qt_g=Search+this+group>`_
Thanks to all the users who `provided feedback <http://groups.google.com/group/ml-devel>`_, `reported bugs <http://bitbucket.org/hudson/magic-lantern/issues>`_,
and supported the Magic Lantern project by `donations <https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=ELJ6U9GGFPL3U&lc=RO&item_name=Magic%20Lantern%20firmware%20for%20Canon%20550D&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHostedGuest>`_!
Also, thanks to `CHDK team <http://chdk.wikia.com/>`_ and all the `contributors and donors for the 5D2 Magic Lantern <http://magiclantern.wikia.com/wiki/Thanks>`_!
Special thanks for people who `donated <https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=ELJ6U9GGFPL3U&lc=RO&item_name=Magic%20Lantern%20firmware%20for%20Canon%20550D&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHostedGuest>`_
in order to help the development of Magic Lantern; your help is very much appreciated!
.. raw:: latex
Also, thanks to the `CHDK team <http://chdk.wikia.com/>`_ and all the `contributors and donors for the 5D2 Magic Lantern <http://magiclantern.wikia.com/wiki/Thanks>`_!
}
Installing Magic Lantern 0.2 for Canon 550D, Firmware 1.0.9
WARNING
......@@ -48,39 +46,31 @@ Important notes
Introduction
============
There are 2 ways of running user code on the 550D/T2i/Kiss X4:
There are 2 ways of running user code on Canon DSLR cameras:
1. using the update process with a ``.fir`` file, which must be digitally signed.
2. using the bootdisk process: the ``autoexec.bin`` file is loaded and executed.
This file does not have to be signed, but the bootdisk flag must be enabled in the camera.
To install Magic Lantern on your camera, you must download the right
magiclantern for your firmware: 1.0.8 or 1.0.9. The recommended way
is to upgrade your camera to 1.0.9 in order to get the latest features.
No development will be done on 1.0.8 any more.
Magic Lantern does not work at all with earlier firmware versions.
Installing Magic Lantern for 550D firmware 1.0.9 for the first time
Installing Magic Lantern for the first time
===========================================================================
**Make sure you have the Canon Firmware 1.0.9 first!**
**Running Magic Lantern on an incorrect firmware version may brick your camera!**
To install Magic Lantern on your camera, you must make sure your camera has the right firmware version; if not, you have to upgrade the firmware first:
If you already use a previous version of Magic Lantern for 550D firmware **1.0.9**, it's easy.
Download the latest ML and unzip everything on your SD card. Done. Enjoy!
* for Canon **550D** / T2i / Kiss X4: upgrade firmware to 1.0.9.
* for Canon **60D**: upgrade firmware to 1.0.9. If you have firmware 1.0.5, you must upgrade first to 1.0.8 and then to 1.0.9.
* For Canon **600D**: upgrade firmware to 1.0.1.
* For Canon **500D**: upgrade firmware to 1.1.0.
If you already use Magic Lantern for 550D/1.0.8, format your card,
upgrade camera firmware to 1.0.9 and follow the ML install steps.
{{clr}}
Step 0. Downloading
~~~~~~~~~~~~~~~~~~~
* Download this release: `magiclantern-0.2.0.rc1.550d.fw109.zip <https://bitbucket.org/hudson/magic-lantern/downloads/magiclantern-0.2.0.rc1.550d.fw109.zip>`_.
* Read `this discussion thread <http://groups.google.com/group/ml-devel/browse_thread/thread/850ec268bc883ceb>`_ for more info.
* Download the `latest Magic Lantern version for your camera <http://magiclantern.wikia.com/wiki/Unified#Downloads>`_
* Read the discussion thread before installing.
Step 1. Enabling bootflag
~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -91,16 +81,14 @@ Step 1. Enabling bootflag
:width: 5cm
* Remove any accessories from your camera (such as battery grip or external flash)
* Restore your camera to default settings (``Clear all camera settings``, from ``Wrench 3`` menu)
* Format the SD card from the camera (low level, from ``Wrench 1`` menu)
* Restore your camera to default settings (``Clear all camera settings``)
* Format the SD card from the camera, using low level format
* Copy ``magiclantern.fir`` from the zip archive on the SD card
* Launch the firmware update process. For this,
start the camera and select ``Firmware ver 1.0.9`` from the ``Wrench 3`` menu
start the camera and select ``Firmware ver 1.x.x`` from the menu
(must be in manual or P mode to select)
* The installer (``magiclantern.fir``) will enable the bootdisk flag in NVRAM
by calling the ``bootdisk_enable()`` function from Canon firmware.
This is the **only** persistent change to your camera, which can be reverted.
* Once the drive light has gone off and stays off for a few seconds, remove the battery.
Step 2. Making the SD card bootable
......@@ -187,18 +175,21 @@ If it doesn't have enough permissions, run it as root:
Step 3. The last one :)
~~~~~~~~~~~~~~~~~~~~~~~
* Delete ``magiclantern.fir``.
* Copy ``autoexec.bin`` and ``cropmks`` on your SDCard. Older builds may require some BMP files and ``magic.cfg``.
* Unzip all files on your SD card.
* Optional: you may delete ``magiclantern.fir``, documentation (``*.pdf``), scripts (``*.sh``, ``*.py``) and ``README``. These files are not needed on the camera, but there's no problem if you leave them on the card.
* Put the card in the camera.
* Switch on your camera, and Magic Lantern (``autoexec.bin``) will boot.
As long as you had enabled the ``BOOTDISK`` flag once, you card is "prepared";
the camera will try to load any ``autoexec.bin``. The ``.fir`` file is not needed any more,
unless for some reason you will want to retry the installation process.
Usage info
==========
* You have to install Magic Lantern on all cards you wish to use with it. Make these cards bootable and copy the required files.
* If you format a card, Magic Lantern will be removed from it, and the camera will start with vanilla firmware.
* You can have some cards with Magic Lantern and other cards without.
* You should not put a card with Magic Lantern for some camera ``X`` in a different camera ``Y``. It won't work and there is risk of causing permanent damage to the camera.
Troubleshooting
~~~~~~~~~~~~~~~
===============
* Check if all doors are closed. The camera will not boot if the SD slot door is open!
......@@ -217,19 +208,21 @@ Troubleshooting
* Always use *safely remove hardware* when copying files to your SD card; otherwise, you may end up with a corrupted file system. The PC may not notice it, but the camera may fail to load ``autoexec.bin`` or to detect cropmarks.
Installing updated Magic Lantern builds
Installing Magic Lantern updates
=======================================
[[Video:550D T2I Magic Lantern: Installing New Builds, Offical / ML in parallel, Deinstalling ML|thumb|300px|right]]
[[Video:MAGIC LANTERN 1.0.9 FIRMWARE HACK:UPDATE Q&A|thumb|300px|right]]
After you've installed ML, you can get updated builds; just unzip them on the SD card (overwrite old files).
To upgrade Magic Lantern, just unzip the new version on the SD card (overwrite old files).
It's highly recommended to install an updated build, usually the last one. They are announced first on the `ML mailing list <http://groups.google.com/group/ml-devel>`_ and on `Vimeo Magic Lantern User Group <http://vimeo.com/groups/magiclantern/forumthread:236203>`_.
Make sure you have the correct firmware version!
`Download link <http://magiclantern.wikia.com/wiki/Unified#Downloads>`_
{{clr}}
Uninstalling Magic Lantern
......@@ -250,38 +243,21 @@ If you know what you are doing, put this in ``magic.cfg`` to reset the ``DISKBOO
magic.disable_bootdiskf = 1
**Reinstalling Canon firmware will NOT remove Magic Lantern!**
Older versions (archived)
=========================
Persistent changes
==================
550D/1.0.9
~~~~~~~~~~
Magic Lantern does the following persistent change to your camera:
* 3 Dec 2010: `magiclantern-0.1.9-rc0_550d_fw109.zip <http://bitbucket.org/hudson/magic-lantern/downloads/magiclantern-0.1.9-rc0_550d_fw109.zip>`_
550D/1.0.8
~~~~~~~~~~
No further development will be done on the 1.0.8 firmware.
Official builds from Trammell Hudson
````````````````````````````````````
* `Announcing pre-alpha firmware <http://groups.google.com/group/ml-devel/msg/49631dc8fec89779>`_
* RC1 release: `magiclantern-550d.rc1.zip <http://bitbucket.org/hudson/magic-lantern/downloads/magiclantern-550d.rc1.zip>`_
* 8 Aug 2010: `Update 550D beta, now with gain control <http://groups.google.com/group/ml-devel/browse_thread/thread/1192bdeeb58e94d5>`_
Unofficial (experimental) builds
````````````````````````````````
* 11 Nov 2010: `magiclantern for 550D, compiled with shorter config file <http://groups.google.com/group/ml-devel/msg/87b96d3cb43b4bec>`_
* 23 Nov 2010: `Recording Internal and external audio simultaneously <http://groups.google.com/group/ml-devel/msg/1c690d8dee580ee3>`_
* 07 Dec 2010: `fixed cropmarks <http://groups.google.com/group/ml-devel/msg/5abd238291b1d2b3>`_
* 09 Dec 2010: `enabled zebras and histogram <http://groups.google.com/group/ml-devel/browse_thread/thread/e15fac669f293d2a>`_
* 11 Dec 2010: `GUI menus & lots of extras <http://groups.google.com/group/ml-devel/browse_thread/thread/97488a67eff87b7e>`_
* 12 Dec 2010: `enabled QScale and spotmeter <http://groups.google.com/group/ml-devel/msg/0dbfe7d9ee043525>`_
* It enables the bootflag from NVRAM, which can be reverted (see `Uninstalling ML from the camera`_).
* Some camera settings changed by Magic Lantern (such as ISO, white balance, picture quality) are saved into a non-volatile memory. To restore these settings, select ``Clear all camera settings`` from Canon menu.
Risks
=====
(this needs some cleanup)
* This firmware does a (very small) (semi-)permanent change to your camera: it changes the ``DISKBOOT`` flag, which is stored in NVRAM. This change can be reverted (see the mailing list and bootflags.c).
* There are no confirmed reports of Magic Lantern doing permanent damage on the 550D.
......
......@@ -15,7 +15,7 @@
\usepackage[colorlinks=true,linkcolor=blue,urlcolor=blue]{hyperref}
\hypersetup{
pdftitle={Magic Lantern 0.2 for Canon 550D, Firmware 1.0.9 -- Installation},
pdftitle={Magic Lantern 0.2.1 -- Installation},
pdfauthor = {Alex Dumitrache <broscutamaker@gmail.com>},
pdfpagelayout = {OneColumn},
pdfpagemode = {UseNone},
......@@ -29,8 +29,8 @@
%%% Body
\begin{document}
\title{Magic Lantern 0.2 for Canon 550D, firmware 1.0.9\\Installation}
\author{\url{http://magiclantern.wikia.com/550D}}
\title{\vspace{-1.5cm}\includegraphics[width=3cm]{Logo.png}\\Magic Lantern 0.2.1\\{\small for Canon 550D, 60D, 600D and 500D}\\Installation}
\author{\url{http://magiclantern.wikia.com/unified}}
\maketitle
\vspace{5mm}
......@@ -60,7 +60,6 @@ Magic Lantern is being developed by independent film makers in our spare time an
\end{center}
\newpage
$body
\end{document}
......
......@@ -142,7 +142,7 @@
%%% Body
\begin{document}
\title{\vspace{-1cm}\includegraphics[width=3cm]{Logo.png}\\Magic Lantern 0.2.1\\{\small for Canon 550D, 60D, 600D and 500D}}
\author{\url{http://magiclantern.wikia.com/}}
\author{\url{http://magiclantern.wikia.com/unified}}
\maketitle
%~ \setlength{\baselineskip}{0mm plus1fil}
......@@ -182,14 +182,13 @@ development team:
\subsubsection*{Thanks}
\begin{itemize}
\item Code contributions: piersg, nandoide, stefano, trho, deti, tapani, phil, xaos, Jason, AlinS, Chuchin, RoaldFre, Vincent Olivier, Colin Peart, MTG, robotsound, Maclema, Adijiwa...
\item Code contributions: piersg, nandoide, stefano, trho, deti, tapani, phil, xaos, Jason, AlinS, Chuchin, RoaldFre, Vincent Olivier, Colin Peart, cpc, msi, robotsound, Maclema, Adijiwa...
\item Card tools authors: Pel, Zeno, lichtjaar
\item Cropmark authors: CameraRick, Robert, bwwd, turbinicarpus, similaar, dremelv21, Piepas...
\item Tutorial authors: sawomedia, Chung Dha, Dave Dugdale, Malcolm Debono, MediaUnlocked, Jeremy, Lauren Stevens, Shayne35mm, Renny Hayes, Daniel Thurau, Dod3032, 3615geek, CineDigital.tv, jeveuxdoncjevilme...
\item All users who tested this software, provided feedback and reported bugs
\item All users who supported Magic Lantern development with donations
\item CHDK project
\item 400plus
\item CHDK and 400plus
\end{itemize}
\newpage
......
......@@ -47,7 +47,7 @@
\usepackage[colorlinks=true,linkcolor=blue,urlcolor=blue]{hyperref}
\hypersetup{
pdftitle={Magic Lantern 0.2 for Canon 550D, Firmware 1.0.9 -- User's Guide},
pdftitle={Magic Lantern 0.2.1 -- User's Guide},
pdfauthor = {Alex Dumitrache <broscutamaker@gmail.com>},
pdfpagelayout = {OneColumn},
pdfpagemode = {UseNone},
......@@ -74,7 +74,7 @@
%%% Body
\begin{document}
\title{\vspace{-1.5cm}\includegraphics[width=3cm]{Logo.png}\\Magic Lantern 0.2.1\\{\small for Canon 550D, 60D, 600D and 500D}\\User's Guide}
\author{\url{http://magiclantern.wikia.com/}}
\author{\url{http://magiclantern.wikia.com/unified}}
\maketitle
\vspace{5mm}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment