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

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

Краткое содержание

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

otNcpDelegateAllowPeekPoke )(uint32_t aAddress, uint16_t aCount) определение типа
bool(*
Определяет тип делегата (указателя функции) для управления поведением операции просмотра/тыкания.
otNcpHdlcSendCallback )(const uint8_t *aBuf, uint16_t aBufLength) определение типа
int(*
Указатель вызывается для отправки данных NCP в кодировке HDLC.

Функции

otNcpHdlcInit ( otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
Инициализируйте NCP на основе кадрирования HDLC.
otNcpHdlcInitMulti ( otInstance **aInstance, uint8_t aCount, 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 .
otNcpRegisterPeekPokeDelegates ( otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)
void
Регистрирует функции делегата peek/poke с модулем NCP.
otNcpSpiInit ( otInstance *aInstance)
void
Инициализируйте NCP на основе кадрирования SPI.
otNcpStreamWrite (int aStreamId, const uint8_t *aDataPtr, int aDataLen)
Отправьте данные на хост через определенный поток.

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

otNcpDelegateAllowPeekPoke

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

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

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

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

otNcpHdlcSendCallback

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

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

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

Функции

отнкпхдлцинит

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

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

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

otNcpHdlcInitMulti

void otNcpHdlcInitMulti(
  otInstance **aInstance,
  uint8_t aCount,
  otNcpHdlcSendCallback aSendCallback
)

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

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

otNcpHdlcReceive

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

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

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

отнкпхдлксенддоне

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.

otNcpRegisterPeekPokeDelegates

void otNcpRegisterPeekPokeDelegates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

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

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

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

отнкпспинит

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 недействителен.

Ресурсы

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