ADIv5: doxygen
commit6f262b69f407e5982be9858d66b5dda6835a2e28
authorDavid Brownell <dbrownell@users.sourceforge.net>
Sun, 7 Feb 2010 03:16:21 +0000 (6 19:16 -0800)
committerDavid Brownell <dbrownell@users.sourceforge.net>
Sun, 7 Feb 2010 03:16:21 +0000 (6 19:16 -0800)
tree7e15d6d38b2772baf10eb9294a9315c342f1b505
parent41d0901115903cb02b42249690b33cf616e133b5
ADIv5: doxygen

Provide doxygen for many of the public ADIv5 interfaces (i.e. the ones
called from Cortex core support code).

Add FIXMEs (and a TODO) to help resolve implementation issues which
became more apparent when trying to document this code:

 - Error-prone context-sensitivity (queued/nonqueued) in many procedures.

 - Procedures that lie by ignoring errors and wrongly claiming success.

Also, there was no point in a return from dap_ap_select(); it can't fail,
and no caller checks its return status.  Clean that up, make it void.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
src/target/arm_adi_v5.c
src/target/arm_adi_v5.h