Сетевой сопроцессор

Этот модуль включает функции, управляющие выполнением стека потоков.

Резюме

Определения типов

otNcpDelegateAllowPeekPoke )(uint32_t aAddress, uint16_t aCount) определение типа
bool(*
Определяет тип делегата (указатель на функцию) для управления поведением операции peek/poke.
otNcpHandlerJoinLegacyNode )(const otExtAddress *aExtAddress) определение типа
void(*
Определяет тип обработчика (указатель функции) для инициирования процесса объединения.
otNcpHandlerSetLegacyUlaPrefix )(const uint8_t *aUlaPrefix) определение типа
void(*
Определяет тип обработчика (указатель функции) для установки устаревшего префикса ULA.
otNcpHandlerStartLegacy )(void) определение типа
void(*
Определяет тип обработчика (указатель функции) для запуска устаревшей сети.
otNcpHandlerStopLegacy )(void) определение типа
void(*
Определяет тип обработчика (указатель функции) для остановки устаревшей сети.
otNcpHdlcSendCallback )(const uint8_t *aBuf, uint16_t aBufLength) определение типа
int(*
Этот указатель функции вызывается для отправки данных NCP в кодировке HDLC.
otNcpLegacyHandlers определение типа
Определяет структуру, содержащую все устаревшие обработчики (указатели функций).

Функции

otNcpHandleDidReceiveNewLegacyUlaPrefix (const uint8_t *aUlaPrefix)
void
Этот обратный вызов вызывается устаревшим стеком, чтобы уведомить об изменении устаревшего префикса ULA.
otNcpHandleLegacyNodeDidJoin (const otExtAddress *aExtAddr)
void
Этот обратный вызов вызывается устаревшим стеком, чтобы уведомить о том, что к сети присоединился новый устаревший узел.
otNcpHdlcInit ( otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
Инициализируйте NCP на основе кадрирования HDLC.
otNcpHdlcReceive (const uint8_t *aBuf, uint16_t aBufLength)
void
Эта функция вызывается после получения данных NCP в кодировке HDLC.
otNcpHdlcSendDone (void)
void
Эта функция вызывается после завершения отправки NCP.
otNcpPlatLogv ( otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Записывает журнал OpenThread, используя otNcpStreamWrite .
otNcpRegisterLegacyHandlers (const otNcpLegacyHandlers *aHandlers)
void
Этот метод регистрирует набор устаревших обработчиков в NCP.
otNcpRegisterPeekPokeDelagates ( otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)
void
Этот метод регистрирует функции делегата peek/poke с модулем NCP.
otNcpSpiInit ( otInstance *aInstance)
void
Инициализируйте NCP на основе кадрирования SPI.
otNcpStreamWrite (int aStreamId, const uint8_t *aDataPtr, int aDataLen)
Отправлять данные на хост через определенный поток.

Структуры

otNcpLegacyHandlers

Определяет структуру, содержащую все устаревшие обработчики (указатели функций).

Определения типов

otNcpDelegateAllowPeekPoke

bool(* otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount)

Определяет тип делегата (указатель на функцию) для управления поведением операции peek/poke.

Эта функция делегата вызывается, чтобы решить, разрешить ли просмотр или просмотр определенной области памяти. Он используется, если включена поддержка NCP для команд peek/poke.

Подробности
Параметры
[in] aAddress
Начальный адрес области памяти.
[in] aCount
Количество байтов для просмотра или тыка.
Возвращает
TRUE, чтобы разрешить просмотр/проверку данной области памяти, FALSE в противном случае.

otNcpHandlerJoinLegacyNode

void(* otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress)

Определяет тип обработчика (указатель функции) для инициирования процесса объединения.

Вызывается, чтобы инициировать устаревшую процедуру присоединения к любому или определенному узлу.

Подробности
Параметры
[in] aExtAddress
Указатель на расширенный адрес узла, к которому нужно присоединиться, или NULL, если требуется присоединиться к любому соседнему узлу.

otNcpHandlerSetLegacyUlaPrefix

void(* otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix)

Определяет тип обработчика (указатель функции) для установки устаревшего префикса ULA.

Вызывается для установки устаревшего префикса ULA.

Подробности
Параметры
[in] aUlaPrefix
Указатель на буфер, содержащий устаревший префикс ULA.

otNcpHandlerStartLegacy

void(* otNcpHandlerStartLegacy)(void)

Определяет тип обработчика (указатель функции) для запуска устаревшей сети.

Вызывается для запуска устаревшей сети.

otNcpHandlerStopLegacy

void(* otNcpHandlerStopLegacy)(void)

Определяет тип обработчика (указатель функции) для остановки устаревшей сети.

Вызывается для остановки устаревшей сети.

otNcpHdlcSendCallback

int(* otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength)

Этот указатель функции вызывается для отправки данных NCP в кодировке HDLC.

Подробности
Параметры
[in] aBuf
Указатель на буфер с выводом.
[in] aBufLength
Длина выходных данных, хранящихся в буфере.
Возвращает
Количество байтов, обработанных обратным вызовом.

otNcpLegacyHandlers

struct otNcpLegacyHandlers otNcpLegacyHandlers

Определяет структуру, содержащую все устаревшие обработчики (указатели функций).

Функции

otNcpHandleDidReceiveNewLegacyUlaPrefix

void otNcpHandleDidReceiveNewLegacyUlaPrefix(
  const uint8_t *aUlaPrefix
)

Этот обратный вызов вызывается устаревшим стеком, чтобы уведомить об изменении устаревшего префикса ULA.

Подробности
Параметры
[in] aUlaPrefix
Указатель на полученный префикс ULA.

otNcpHandleLegacyNodeDidJoin

void otNcpHandleLegacyNodeDidJoin(
  const otExtAddress *aExtAddr
)

Этот обратный вызов вызывается устаревшим стеком, чтобы уведомить о том, что к сети присоединился новый устаревший узел.

Подробности
Параметры
[in] aExtAddr
Указатель на расширенный адрес присоединенного узла.

otNcpHdlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Инициализируйте NCP на основе кадрирования HDLC.

Подробности
Параметры
[in] aInstance
Структура экземпляра OpenThread.
[in] aSendCallback
Указатель функции, используемый для отправки данных NCP.

otNcpHdlcReceive

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

Эта функция вызывается после получения данных NCP в кодировке HDLC.

Подробности
Параметры
[in] aBuf
Указатель на буфер.
[in] aBufLength
Длина данных, хранящихся в буфере.

otNcpHdlcSendDone

void otNcpHdlcSendDone(
  void
)

Эта функция вызывается после завершения отправки NCP.

otNcpPlatLogv

void otNcpPlatLogv(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aFormat,
  va_list aArgs
)

Записывает журнал OpenThread, используя otNcpStreamWrite .

Подробности
Параметры
[in] aLogLevel
Уровень журнала.
[in] aLogRegion
Область журнала.
[in] aFormat
Указатель на строку формата.
[in] aArgs
va_list, соответствующий aFormat.

otNcpRegisterLegacyHandlers

void otNcpRegisterLegacyHandlers(
  const otNcpLegacyHandlers *aHandlers
)

Этот метод регистрирует набор устаревших обработчиков в NCP.

Набор обработчиков, предоставляемых структурой aHandlers , используется кодом NCP для запуска/остановки устаревшей сети. aHandlers может иметь значение NULL, чтобы отключить устаревшую поддержку NCP. Отдельные обработчики в данной структуре обработчиков также могут иметь значение NULL.

Подробности
Параметры
[in] aHandlers
Указатель на структуру обработчика.

otNcpRegisterPeekPokeDelagates

void otNcpRegisterPeekPokeDelagates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Этот метод регистрирует функции делегата peek/poke с модулем NCP.

Функции делегата вызываются модулем NCP, чтобы решить, разрешить ли просмотр или просмотр определенной области памяти. Если указатель делегата установлен в NULL, он разрешает операцию peek/poke для любого адреса.

Подробности
Параметры
[in] aAllowPeekDelegate
Указатель функции делегата для операции просмотра.
[in] aAllowPokeDelegate
Указатель функции-делегата для операции тыка.

otNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Инициализируйте NCP на основе кадрирования SPI.

Подробности
Параметры
[in] aInstance
Структура экземпляра OpenThread.

otNcpStreamWrite

otError otNcpStreamWrite(
  int aStreamId,
  const uint8_t *aDataPtr,
  int aDataLen
)

Отправлять данные на хост через определенный поток.

Эта функция пытается отправить заданные данные на хост, используя заданный aStreamId. Это полезно для сообщений об ошибках, реализации консолей отладки/диагностики и потенциально других типов потоков данных.

Запись либо принимается полностью, либо отклоняется. Частичная запись не предпринимается.

Подробности
Параметры
[in] aStreamId
Числовой идентификатор потока для записи. Если установлено значение «0», по умолчанию будет использоваться поток отладки.
[in] aDataPtr
Указатель на данные для отправки в потоке. Если aDataLen не равен нулю, этот параметр НЕ ДОЛЖЕН быть NULL.
[in] aDataLen
Количество байтов данных из aDataPtr для отправки.
Возвращаемые значения
OT_ERROR_NONE
Данные поставлены в очередь для доставки на хост.
OT_ERROR_BUSY
Недостаточно ресурсов для выполнения этого запроса. Обычно это временное состояние.
OT_ERROR_INVALID_ARGS
Данный aStreamId недействителен.

Макросы

OT_NCP_LEGACY_ULA_PREFIX_LENGTH

 OT_NCP_LEGACY_ULA_PREFIX_LENGTH 8

Устаревший размер ULA (в байтах)

Ресурсы

Разделы справочника по API OpenThread взяты из исходного кода, доступного на GitHub . Чтобы получить дополнительную информацию или внести свой вклад в нашу документацию, обратитесь к разделу Ресурсы .