Справочник API
Target API выпуска 0.5.0, API_VERSION=3. Для каждой группы — сигнатуры, первый выпуск, изменения API 3 и примеры.
API 3 кратко
Обычный def выполняет операции по очереди. В async def навигация (reach, step, until, finish, resume, reset) и call ожидаются через await; resume(sync=False) отпускает цель, await wait/halt ждут с таймаутом. Чтение, запись, проверки и записи журнала await не требуют. Выражения не вызывают функции цели.
Группы методов
Сценарий: def и async def
Декоратор объявляет сценарий; форма функции выбирает режим исполнения.
Навигация: reach, step, until, finish
Дойти до функции или строки, сделать шаг, выполнить до возврата. Каждая операция возвращает остановку.
Живое окно: resume, wait, halt
Отпустить цель, ждать остановки с таймаутом, остановить с подтверждением.
Данные: read и write
Чтение объекта по имени или выражению, запись значения или таблицы записей.
Выражения и память: evaluate, memory, symbol
Значение выражения нужного типа; байты SRAM/Flash по адресу символа.
Регистры: mmio.read и mmio.write
Один прямой запрос к регистру по имени из снимка SVD с проверкой прав и эффектов.
Проверки: check, сопоставители, refused
Именованная проверка или таблица проверок; ожидаемый отказ API с кодом.
Инъекции: ret и call
Подменить возврат текущей функции; вызвать функцию прошивки и получить результат.
Точки: breakpoint, watch, Point, clear
Точки останова и наблюдения как объекты Point с состоянием и снятием.
Журнал и SKIP: record, records, skip
Произвольные данные в отчёт; выборка своих записей; завершение неприменимого сценария.
Контекст: profile, registers, frames, locals
Данные прогона и проекта; регистры ядра, стек вызовов, локальные переменные и аргументы.
Сброс и команды GDB: reset, execute
Сброс цели с остановкой; произвольная команда GDB как низкоуровневый выход.
Ошибки: ApiError, CheckFailed, RecordError
Отказ операции с кодом, стадией и эффектом; проваленная проверка; ошибка журнала.
Удалённые имена
Были доступны с 0.1.0-rc.1 по 0.3.0 (в 0.3.0 с предупреждением deprecated), удалены в 0.4.0.
| Имя | Замена |
|---|---|
value | read, evaluate |
fields | read(path, fields=…), check(rows) |
set_value | write |
force_return | ret |