Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.

Co-Processor Jaringan

Modul ini mencakup fungsi yang mengontrol eksekusi stack Thread.

Ringkasan

Typedef

otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount) typedef
bool(*
Menentukan jenis delegasi (pointer fungsi) untuk mengontrol perilaku operasi intip/poke.
otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress) typedef
void(*
Menentukan jenis pengendali (pointer fungsi) untuk memulai proses bergabung.
otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix) typedef
void(*
Menentukan jenis pengendali (pointer fungsi) untuk menyetel awalan ULA lama.
otNcpHandlerStartLegacy)(void) typedef
void(*
Menentukan jenis pengendali (pointer fungsi) untuk memulai jaringan lama.
otNcpHandlerStopLegacy)(void) typedef
void(*
Menentukan jenis pengendali (pointer fungsi) untuk menghentikan jaringan lama.
otNcpHdlcSendCallback)(const uint8_t *aBuf, uint16_t aBufLength) typedef
int(*
Pointer fungsi ini dipanggil untuk mengirim data NCP yang dienkode HDLC.
otNcpLegacyHandlers typedef
Menentukan struct yang berisi semua pengendali lama (pointer fungsi).

Fungsi

otNcpHandleDidReceiveNewLegacyUlaPrefix(const uint8_t *aUlaPrefix)
void
Callback ini dipanggil oleh stack lama untuk memberi tahu bahwa awalan ULA lama telah berubah.
otNcpHandleLegacyNodeDidJoin(const otExtAddress *aExtAddr)
void
Callback ini dipanggil oleh stack lama untuk memberi tahu bahwa node lama yang baru memang bergabung dengan jaringan.
otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSendCallback)
void
Melakukan inisialisasi NCP berdasarkan framing HDLC.
otNcpHdlcReceive(const uint8_t *aBuf, uint16_t aBufLength)
void
Fungsi ini dipanggil setelah data NCP yang dienkode HDLC diterima.
otNcpHdlcSendDone(void)
void
Fungsi ini dipanggil setelah pengiriman NCP selesai.
otNcpPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
void
Menulis Log OpenThread menggunakan otNcpStreamWrite.
otNcpRegisterLegacyHandlers(const otNcpLegacyHandlers *aHandlers)
void
Metode ini mendaftarkan serangkaian pengendali lama dengan NCP.
otNcpRegisterPeekPokeDelagates(otNcpDelegateAllowPeekPoke aAllowPeekDelegate, otNcpDelegateAllowPeekPoke aAllowPokeDelegate)
void
Metode ini mendaftarkan fungsi delegasi melihat/mencolok dengan modul NCP.
otNcpSpiInit(otInstance *aInstance)
void
Melakukan inisialisasi NCP berdasarkan framing SPI.
otNcpStreamWrite(int aStreamId, const uint8_t *aDataPtr, int aDataLen)
Mengirim data ke host melalui aliran tertentu.

Struct

otNcpLegacyHandlers

Menentukan struct yang berisi semua pengendali lama (pointer fungsi).

Typedef

otNcpDelegateAllowPeekPoke

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

Menentukan jenis delegasi (pointer fungsi) untuk mengontrol perilaku operasi intip/poke.

Fungsi delegasi ini dipanggil untuk menentukan apakah akan mengizinkan intip atau penyusupan region memori tertentu. Kunci ini digunakan jika dukungan NCP untuk perintah intip/poke diaktifkan.

Detail
Parameter
[in] aAddress
Alamat awal region memori.
[in] aCount
Jumlah byte untuk intip atau colok.
Menampilkan
TRUE untuk mengizinkan mengintip/mencabut area memori tertentu, FALSE jika sebaliknya.

otNcpHandlerJoinLegacyNode

void(* otNcpHandlerJoinLegacyNode)(const otExtAddress *aExtAddress)

Menentukan jenis pengendali (pointer fungsi) untuk memulai proses bergabung.

Dipanggil untuk memulai prosedur penggabungan lama ke salah satu atau node tertentu.

Detail
Parameter
[in] aExtAddress
Pointer ke alamat yang diperluas untuk node yang akan bergabung atau NULL jika diinginkan untuk bergabung dengan node yang berdekatan.

otNcpHandlerSetLegacyUlaPrefix

void(* otNcpHandlerSetLegacyUlaPrefix)(const uint8_t *aUlaPrefix)

Menentukan jenis pengendali (pointer fungsi) untuk menyetel awalan ULA lama.

Dipanggil untuk menyetel awalan ULA lama.

Detail
Parameter
[in] aUlaPrefix
Pointer untuk buffering yang berisi awalan ULA lama.

otNcpHandlerStartLegacy

void(* otNcpHandlerStartLegacy)(void)

Menentukan jenis pengendali (pointer fungsi) untuk memulai jaringan lama.

Dipanggil untuk memulai jaringan lama.

otNcpHandlerStopLegacy

void(* otNcpHandlerStopLegacy)(void)

Menentukan jenis pengendali (pointer fungsi) untuk menghentikan jaringan lama.

Dipanggil untuk menghentikan jaringan lama.

otNcpHdlcSendCallback

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

Pointer fungsi ini dipanggil untuk mengirim data NCP yang dienkode HDLC.

Detail
Parameter
[in] aBuf
Pointer ke buffer dengan output.
[in] aBufLength
Panjang data output yang disimpan dalam buffer.
Menampilkan
Jumlah byte yang diproses oleh callback.

otNcpLegacyHandlers

struct otNcpLegacyHandlers otNcpLegacyHandlers

Menentukan struct yang berisi semua pengendali lama (pointer fungsi).

Fungsi

otNcpHandleDidReceiveNewLegacyUlaPrefix

void otNcpHandleDidReceiveNewLegacyUlaPrefix(
  const uint8_t *aUlaPrefix
)

Callback ini dipanggil oleh stack lama untuk memberi tahu bahwa awalan ULA lama telah berubah.

Detail
Parameter
[in] aUlaPrefix
Pointer ke awalan ULA yang diterima.

otNcpHandleLegacyNodeDidJoin

void otNcpHandleLegacyNodeDidJoin(
  const otExtAddress *aExtAddr
)

Callback ini dipanggil oleh stack lama untuk memberi tahu bahwa node lama yang baru memang bergabung dengan jaringan.

Detail
Parameter
[in] aExtAddr
Pointer ke alamat lengkap dari node yang digabungkan.

otNcpHdlcInit

void otNcpHdlcInit(
  otInstance *aInstance,
  otNcpHdlcSendCallback aSendCallback
)

Melakukan inisialisasi NCP berdasarkan framing HDLC.

Detail
Parameter
[in] aInstance
Struktur instance OpenThread.
[in] aSendCallback
Pointer fungsi yang digunakan untuk mengirim data NCP.

otNcpHdlcReceive

void otNcpHdlcReceive(
  const uint8_t *aBuf,
  uint16_t aBufLength
)

Fungsi ini dipanggil setelah data NCP yang dienkode HDLC diterima.

Detail
Parameter
[in] aBuf
Pointer ke buffer.
[in] aBufLength
Panjang data yang disimpan dalam buffer.

otNcpHdlcSendSelesai

void otNcpHdlcSendDone(
  void
)

Fungsi ini dipanggil setelah pengiriman NCP selesai.

otNcpPlatLogv

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

Menulis Log OpenThread menggunakan otNcpStreamWrite.

Detail
Parameter
[in] aLogLevel
Tingkat log.
[in] aLogRegion
Region log.
[in] aFormat
Pointer ke string format.
[in] aArgs
va_list yang cocok dengan aFormat.

otNcpRegisterLegacyHandlers

void otNcpRegisterLegacyHandlers(
  const otNcpLegacyHandlers *aHandlers
)

Metode ini mendaftarkan serangkaian pengendali lama dengan NCP.

Kumpulan pengendali yang disediakan oleh struct aHandlers digunakan oleh kode NCP untuk memulai/menghentikan jaringan lama. aHandlers dapat menjadi NULL untuk menonaktifkan dukungan lama pada NCP. Setiap pengendali di struct pengendali yang diberikan juga dapat berupa NULL.

Detail
Parameter
[in] aHandlers
Pointer ke struct pengendali.

otNcpRegisterPeekPokeDelagates

void otNcpRegisterPeekPokeDelagates(
  otNcpDelegateAllowPeekPoke aAllowPeekDelegate,
  otNcpDelegateAllowPeekPoke aAllowPokeDelegate
)

Metode ini mendaftarkan fungsi delegasi melihat/mencolok dengan modul NCP.

Fungsi delegasi dipanggil oleh modul NCP untuk memutuskan apakah akan mengizinkan tindakan mengintip atau menyadap region memori tertentu. Jika pointer delegasi ditetapkan ke NULL, ini akan memungkinkan operasi intip/poke untuk alamat mana pun.

Detail
Parameter
[in] aAllowPeekDelegate
Delegasikan pointer fungsi untuk operasi intip.
[in] aAllowPokeDelegate
Mendelegasikan pointer fungsi untuk operasi poke.

otNcpSpiInit

void otNcpSpiInit(
  otInstance *aInstance
)

Melakukan inisialisasi NCP berdasarkan framing SPI.

Detail
Parameter
[in] aInstance
Struktur instance OpenThread.

otNcpStreamTulis

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

Mengirim data ke host melalui aliran tertentu.

Fungsi ini mencoba mengirim data yang diberikan ke host menggunakan aStreamId tertentu. Hal ini berguna untuk melaporkan pesan error, menerapkan konsol debug/diagnostik, dan kemungkinan jenis aliran data lainnya.

Penulisan diterima secara keseluruhan atau ditolak. Penulisan parsial tidak dicoba.

Detail
Parameter
[in] aStreamId
ID numerik untuk streaming. Jika disetel ke '0', akan secara default disetel ke streaming debug.
[in] aDataPtr
Pointer ke data yang akan dikirim pada aliran. Jika aDataLen bukan nol, parameter ini TIDAK BOLEH NULL.
[in] aDataLen
Jumlah byte data dari aDataPtr yang akan dikirim.
Nilai yang Ditampilkan
OT_ERROR_NONE
Data dimasukkan dalam antrean pengiriman ke host.
OT_ERROR_BUSY
Tidak cukup resource untuk menyelesaikan permintaan ini. Hal ini biasanya bersifat sementara.
OT_ERROR_INVALID_ARGS
aStreamId yang diberikan tidak valid.

Makro

OT_NCP_LEGACY_ULA_PREFIX_LENGTH

 OT_NCP_LEGACY_ULA_PREFIX_LENGTH 8

Ukuran ULA lama (dalam byte)

Resource

Topik Referensi OpenThread API berasal dari kode sumber, yang tersedia di GitHub. Untuk mengetahui informasi selengkapnya, atau untuk berkontribusi ke dokumentasi kami, lihat Referensi.