Procesor sieciowy

Ten moduł zawiera funkcje, które kontrolują wykonywanie stosu w wątku.

Podsumowanie

Typy
otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount) typedef
bool(*
Definiuje typ przedstawiciela (wskaźnika funkcji), aby kontrolować działanie działania „peek/poke”.
otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress) typedef
void(*
Określa typ modułu obsługi (wskaźnika funkcji) na potrzeby inicjowania procesu dołączania.
otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix) typedef
void(*
Określa typ modułu obsługi (wskaźnika funkcji) do ustawiania starszego prefiksu ULA.
otNcpHandlerStartLegacy)(void) typedef
void(*
Określa typ modułu obsługi (wskaźnika funkcji) na potrzeby uruchamiania starszej sieci.
otNcpHandlerStopLegacy)(void) typedef
void(*
Definiuje typ modułu obsługi (wskaźnika funkcji), by zatrzymać starszą sieć.
otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength) typedef
int(*
Ten wskaźnik funkcji jest wywoływany w celu wysyłania danych NCP zakodowanych w HDLC.
otNcpLegacyHandlers typedef
Definiuje strukturę zawierającą wszystkie starsze moduły obsługi (wskaźniki funkcji).

Funkcje
otNcpHandleDidReceiveNewLegacyUlaPrefix(const uint8_t *aUlaPrefix)
void
To wywołanie zwrotne jest wywoływane przez stary stos w celu powiadomienia o zmianie starszego prefiksu ULA.
otNcpHandleLegacyNodeDidJoin(const otExtAddress *aExtAddr)
void
To wywołanie zwrotne jest wywoływane przez starszy stos w celu powiadomienia, że nowy starszy węzeł dołączył do sieci.
otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
Inicjuj NCP na podstawie kadrowania HDLC.
otNcpHdlcReceive(const uint8_t *aBuf, uint16_t aBufLength)
void
Ta funkcja jest wywoływana po odebraniu danych NCP zakodowanych w HDLC.
otNcpHdlcSendDone(void)
void
Ta funkcja jest wywoływana po zakończeniu wysyłania NCP.
otNcpPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Zapisuje log OpenThread za pomocą otNcpStreamWrite.
otNcpRegisterLegacyHandlers(const otNcpLegacyHandlers *aHandlers)
void
Ta metoda rejestruje zestaw starszych modułów obsługi z modułem NCP.
otNcpRegisterPeekPokeDelagates(otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)
void
Ta metoda rejestruje funkcje przekazywania „peek/poke” z modułem NCP.
otNcpSpiInit(otInstance *aInstance)
void
Inicjuj NCP na podstawie kadrowania SPI.
otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen)
Wysyłaj dane do hosta za pomocą określonego strumienia.

Struktury
otNcpLegacyHandlers

Definiuje strukturę zawierającą wszystkie starsze moduły obsługi (wskaźniki funkcji).

Typy

otNcpPrzekazywanieZezwalajPeekPoke

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

Definiuje typ przedstawiciela (wskaźnika funkcji), aby kontrolować działanie działania „peek/poke”.

Ta funkcja przekazywania jest wywoływana w celu określenia, czy należy zezwolić na szybki podgląd poszczególnych regionów pamięci. Jest on używany, jeśli włączona jest obsługa NCP w przypadku poleceń peek/poke.

Szczegóły
Parametry
[in] aAddress
Adres początkowy regionu pamięci.
[in] aCount
Liczba bajtów do wyświetlenia.
Zwroty
TRUE (zezwalaj na podgląd) dla danego regionu pamięci. W przeciwnym razie wpisz FALSE.

otNcpHandlerjoinLegacyNode

void(* otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress)

Określa typ modułu obsługi (wskaźnika funkcji) na potrzeby inicjowania procesu dołączania.

Wywoływana w celu zainicjowania starszej procedury łączenia w dowolnym lub konkretnym węźle.

Szczegóły
Parametry
[in] aExtAddress
Wskaźnik wskazujący rozszerzony adres węzła, który ma zostać dołączony, lub wartość NULL, aby dołączyć do dowolnego pobliskiego węzła.

OTNcpHandlerSetLegacyUlaPrefiks

void(* otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix)

Określa typ modułu obsługi (wskaźnika funkcji) do ustawiania starszego prefiksu ULA.

Wywoływane, aby ustawić starszy prefiks ULA.

Szczegóły
Parametry
[in] aUlaPrefix
Wskaźnik służący do buforowania zawierający starszy prefiks ULA.

Funkcja OTNcpHandlerStartLegacy

void(* otNcpHandlerStartLegacy)(void)

Określa typ modułu obsługi (wskaźnika funkcji) na potrzeby uruchamiania starszej sieci.

Wywołano uruchomienie starszej sieci.

OTNcpHandlerStopLegacy

void(* otNcpHandlerStopLegacy)(void)

Definiuje typ modułu obsługi (wskaźnika funkcji), by zatrzymać starszą sieć.

Wywołano, aby zatrzymać starszą sieć.

otNcpHdlcSendCallback

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

Ten wskaźnik funkcji jest wywoływany w celu wysyłania danych NCP zakodowanych w HDLC.

Szczegóły
Parametry
[in] aBuf
Wskaźnik do bufora z wynikami.
[in] aBufLength
Długość danych wyjściowych przechowywanych w buforze.
Zwroty
Liczba bajtów przetworzonych przez wywołanie zwrotne.

Funkcja OTNcpLegacyHandlers

struct otNcpLegacyHandlers otNcpLegacyHandlers

Definiuje strukturę zawierającą wszystkie starsze moduły obsługi (wskaźniki funkcji).

Funkcje

otNcpHandleDoneReceiveNewLegacyUlaPrefix;

void otNcpHandleDidReceiveNewLegacyUlaPrefix(
  const uint8_t *aUlaPrefix
)

To wywołanie zwrotne jest wywoływane przez stary stos w celu powiadomienia o zmianie starszego prefiksu ULA.

Szczegóły
Parametry
[in] aUlaPrefix
Wskaźnik otrzymanego prefiksu ULA.

otNcpHandleLegacyNodeDoesDołącz

void otNcpHandleLegacyNodeDidJoin(
  const otExtAddress *aExtAddr
)

To wywołanie zwrotne jest wywoływane przez starszy stos w celu powiadomienia, że nowy starszy węzeł dołączył do sieci.

Szczegóły
Parametry
[in] aExtAddr
Wskaźnik wskazujący rozszerzony adres połączonego węzła.

OTNcpHdlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Inicjuj NCP na podstawie kadrowania HDLC.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
[in] aSendCallback
Wskaźnik funkcji używany do wysyłania danych NCP.

OTNcpHdlcReceive

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

Ta funkcja jest wywoływana po odebraniu danych NCP zakodowanych w HDLC.

Szczegóły
Parametry
[in] aBuf
Wskaźnik bufora.
[in] aBufLength
Długość danych przechowywanych w buforze.

otNcpHdlcSendDone

void otNcpHdlcSendDone(
  void
)

Ta funkcja jest wywoływana po zakończeniu wysyłania NCP.

otNcpPlatLogv

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

Zapisuje log OpenThread za pomocą otNcpStreamWrite.

Szczegóły
Parametry
[in] aLogLevel
Poziom rejestrowania.
[in] aLogRegion
Region dziennika.
[in] aFormat
Wskaźnik formatu ciągu znaków.
[in] aArgs
va_list pasuje do formatu.

otNcpRegisterLegacyHandlers,

void otNcpRegisterLegacyHandlers(
  const otNcpLegacyHandlers *aHandlers
)

Ta metoda rejestruje zestaw starszych modułów obsługi z modułem NCP.

Zestaw modułów obsługi uporządkowanych przez strukturę aHandlers jest używany przez kod NCP do uruchamiania/zatrzymywania starszej sieci. aHandlers może mieć wartość NULL, aby wyłączyć starszą obsługę NCP. Poszczególne moduły obsługi w podanej strukturze modułów mogą też mieć wartość NULL.

Szczegóły
Parametry
[in] aHandlers
Wskaźnik dotyczący struktury modułu obsługi.

otNcpRegisterPeekPokeDelagates

void otNcpRegisterPeekPokeDelagates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Ta metoda rejestruje funkcje przekazywania „peek/poke” z modułem NCP.

Funkcje przekazywania są wywoływane przez moduł NCP w celu podjęcia decyzji, czy zezwolić na szybki podgląd poszczególnych regionów pamięci. Jeśli wskaźnik przekazywania dostępu ma wartość NULL, dozwolone jest działanie działania „peek/poke” dla dowolnego adresu.

Szczegóły
Parametry
[in] aAllowPeekDelegate
Przekaż wskaźnik funkcji do działania podglądu.
[in] aAllowPokeDelegate
Przekaż wskaźnik funkcji na potrzeby działania poke.

OTNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Inicjuj NCP na podstawie kadrowania SPI.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.

otNcpStreamWrite

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

Wysyłaj dane do hosta za pomocą określonego strumienia.

Ta funkcja próbuje wysłać dane do hosta, używając podanego identyfikatora aStreamId. Jest to przydatne w przypadku zgłaszania komunikatów o błędach, implementowania konsol debugowania/diagnostycznych i potencjalnie innych typów strumieni danych.

Tekst jest w całości akceptowany lub odrzucony. Nie są podejmowane próby zapisu częściowego.

Szczegóły
Parametry
[in] aStreamId
Identyfikator numeryczny strumienia, w którym zostanie zapisany zapis. Jeśli zasada ma wartość '0', jest ona domyślna jako strumień debugowania.
[in] aDataPtr
Wskaźnik wskazujący dane do wysłania w strumieniu Jeśli parametr aDataLen ma wartość inną niż 0, ten parametr NIE może mieć wartości NULL.
[in] aDataLen
Liczba bajtów danych z adataPtr do wysłania.
Zwracane wartości
OT_ERROR_NONE
Dane zostały umieszczone w kolejce do dostarczenia do hosta.
OT_ERROR_BUSY
Za mało zasobów, by zrealizować to żądanie. Jest to zwykle stan przejściowy.
OT_ERROR_INVALID_ARGS
Podany parametr aStreamId jest nieprawidłowy.

Makra

OT_NCP_LEGACY_ULA_PREFIX_LENGTH

 OT_NCP_LEGACY_ULA_PREFIX_LENGTH 8

Starszy rozmiar ULA (w bajtach)

Zasoby

Tematy referencyjne interfejsu API OpenThread pochodzą z kodu źródłowego i są dostępne w GitHub. Więcej informacji oraz dodatkowe informacje znajdziesz w materiałach.