12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516 |
- /** @file
- * @brief Buffer management.
- */
- /*
- * Copyright (c) 2015 Intel Corporation
- *
- * SPDX-License-Identifier: Apache-2.0
- */
- #ifndef ZEPHYR_INCLUDE_NET_BUF_H_
- #define ZEPHYR_INCLUDE_NET_BUF_H_
- #include <stddef.h>
- #include <zephyr/types.h>
- #include <sys/util.h>
- #include <zephyr.h>
- #ifndef CONFIG_NET_BUF_USER_DATA_SIZE
- #define CONFIG_NET_BUF_USER_DATA_SIZE 0
- #endif
- #ifdef __cplusplus
- extern "C" {
- #endif
- /* Actions add start */
- #define NET_BUF_TIMESTAMP_CHECK_TIME (10) /* 10ms */
- /* Actions add end */
- /**
- * @brief Network buffer library
- * @defgroup net_buf Network Buffer Library
- * @ingroup networking
- * @{
- */
- /* Alignment needed for various parts of the buffer definition */
- #define __net_buf_align __aligned(sizeof(void *))
- /**
- * @def NET_BUF_SIMPLE_DEFINE
- * @brief Define a net_buf_simple stack variable.
- *
- * This is a helper macro which is used to define a net_buf_simple object
- * on the stack.
- *
- * @param _name Name of the net_buf_simple object.
- * @param _size Maximum data storage for the buffer.
- */
- #define NET_BUF_SIMPLE_DEFINE(_name, _size) \
- uint8_t net_buf_data_##_name[_size]; \
- struct net_buf_simple _name = { \
- .data = net_buf_data_##_name, \
- .len = 0, \
- .size = _size, \
- .__buf = net_buf_data_##_name, \
- }
- /**
- * @def NET_BUF_SIMPLE_DEFINE_STATIC
- * @brief Define a static net_buf_simple variable.
- *
- * This is a helper macro which is used to define a static net_buf_simple
- * object.
- *
- * @param _name Name of the net_buf_simple object.
- * @param _size Maximum data storage for the buffer.
- */
- #define NET_BUF_SIMPLE_DEFINE_STATIC(_name, _size) \
- static __noinit uint8_t net_buf_data_##_name[_size]; \
- static struct net_buf_simple _name = { \
- .data = net_buf_data_##_name, \
- .len = 0, \
- .size = _size, \
- .__buf = net_buf_data_##_name, \
- }
- /**
- * @brief Simple network buffer representation.
- *
- * This is a simpler variant of the net_buf object (in fact net_buf uses
- * net_buf_simple internally). It doesn't provide any kind of reference
- * counting, user data, dynamic allocation, or in general the ability to
- * pass through kernel objects such as FIFOs.
- *
- * The main use of this is for scenarios where the meta-data of the normal
- * net_buf isn't needed and causes too much overhead. This could be e.g.
- * when the buffer only needs to be allocated on the stack or when the
- * access to and lifetime of the buffer is well controlled and constrained.
- */
- struct net_buf_simple {
- /** Pointer to the start of data in the buffer. */
- uint8_t *data;
- /**
- * Length of the data behind the data pointer.
- *
- * To determine the max length, use net_buf_simple_max_len(), not #size!
- */
- uint16_t len;
- /** Amount of data that net_buf_simple#__buf can store. */
- uint16_t size;
- /** Start of the data storage. Not to be accessed directly
- * (the data pointer should be used instead).
- */
- uint8_t *__buf;
- };
- /**
- * @def NET_BUF_SIMPLE
- * @brief Define a net_buf_simple stack variable and get a pointer to it.
- *
- * This is a helper macro which is used to define a net_buf_simple object on
- * the stack and the get a pointer to it as follows:
- *
- * struct net_buf_simple *my_buf = NET_BUF_SIMPLE(10);
- *
- * After creating the object it needs to be initialized by calling
- * net_buf_simple_init().
- *
- * @param _size Maximum data storage for the buffer.
- *
- * @return Pointer to stack-allocated net_buf_simple object.
- */
- #define NET_BUF_SIMPLE(_size) \
- ((struct net_buf_simple *)(&(struct { \
- struct net_buf_simple buf; \
- uint8_t data[_size]; \
- }) { \
- .buf.size = _size, \
- }))
- /**
- * @brief Initialize a net_buf_simple object.
- *
- * This needs to be called after creating a net_buf_simple object using
- * the NET_BUF_SIMPLE macro.
- *
- * @param buf Buffer to initialize.
- * @param reserve_head Headroom to reserve.
- */
- static inline void net_buf_simple_init(struct net_buf_simple *buf,
- size_t reserve_head)
- {
- if (!buf->__buf) {
- buf->__buf = (uint8_t *)buf + sizeof(*buf);
- }
- buf->data = buf->__buf + reserve_head;
- buf->len = 0U;
- }
- /**
- * @brief Initialize a net_buf_simple object with data.
- *
- * Initialized buffer object with external data.
- *
- * @param buf Buffer to initialize.
- * @param data External data pointer
- * @param size Amount of data the pointed data buffer if able to fit.
- */
- void net_buf_simple_init_with_data(struct net_buf_simple *buf,
- void *data, size_t size);
- /**
- * @brief Reset buffer
- *
- * Reset buffer data so it can be reused for other purposes.
- *
- * @param buf Buffer to reset.
- */
- static inline void net_buf_simple_reset(struct net_buf_simple *buf)
- {
- buf->len = 0U;
- buf->data = buf->__buf;
- }
- /**
- * Clone buffer state, using the same data buffer.
- *
- * Initializes a buffer to point to the same data as an existing buffer.
- * Allows operations on the same data without altering the length and
- * offset of the original.
- *
- * @param original Buffer to clone.
- * @param clone The new clone.
- */
- void net_buf_simple_clone(const struct net_buf_simple *original,
- struct net_buf_simple *clone);
- /**
- * @brief Prepare data to be added at the end of the buffer
- *
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param len Number of bytes to increment the length with.
- *
- * @return The original tail of the buffer.
- */
- void *net_buf_simple_add(struct net_buf_simple *buf, size_t len);
- /**
- * @brief Copy given number of bytes from memory to the end of the buffer
- *
- * Increments the data length of the buffer to account for more data at the
- * end.
- *
- * @param buf Buffer to update.
- * @param mem Location of data to be added.
- * @param len Length of data to be added
- *
- * @return The original tail of the buffer.
- */
- void *net_buf_simple_add_mem(struct net_buf_simple *buf, const void *mem,
- size_t len);
- /**
- * @brief Add (8-bit) byte at the end of the buffer
- *
- * Increments the data length of the buffer to account for more data at the
- * end.
- *
- * @param buf Buffer to update.
- * @param val byte value to be added.
- *
- * @return Pointer to the value added
- */
- uint8_t *net_buf_simple_add_u8(struct net_buf_simple *buf, uint8_t val);
- /**
- * @brief Add 16-bit value at the end of the buffer
- *
- * Adds 16-bit value in little endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 16-bit value to be added.
- */
- void net_buf_simple_add_le16(struct net_buf_simple *buf, uint16_t val);
- /**
- * @brief Add 16-bit value at the end of the buffer
- *
- * Adds 16-bit value in big endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 16-bit value to be added.
- */
- void net_buf_simple_add_be16(struct net_buf_simple *buf, uint16_t val);
- /**
- * @brief Add 24-bit value at the end of the buffer
- *
- * Adds 24-bit value in little endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 24-bit value to be added.
- */
- void net_buf_simple_add_le24(struct net_buf_simple *buf, uint32_t val);
- /**
- * @brief Add 24-bit value at the end of the buffer
- *
- * Adds 24-bit value in big endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 24-bit value to be added.
- */
- void net_buf_simple_add_be24(struct net_buf_simple *buf, uint32_t val);
- /**
- * @brief Add 32-bit value at the end of the buffer
- *
- * Adds 32-bit value in little endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 32-bit value to be added.
- */
- void net_buf_simple_add_le32(struct net_buf_simple *buf, uint32_t val);
- /**
- * @brief Add 32-bit value at the end of the buffer
- *
- * Adds 32-bit value in big endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 32-bit value to be added.
- */
- void net_buf_simple_add_be32(struct net_buf_simple *buf, uint32_t val);
- /**
- * @brief Add 48-bit value at the end of the buffer
- *
- * Adds 48-bit value in little endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 48-bit value to be added.
- */
- void net_buf_simple_add_le48(struct net_buf_simple *buf, uint64_t val);
- /**
- * @brief Add 48-bit value at the end of the buffer
- *
- * Adds 48-bit value in big endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 48-bit value to be added.
- */
- void net_buf_simple_add_be48(struct net_buf_simple *buf, uint64_t val);
- /**
- * @brief Add 64-bit value at the end of the buffer
- *
- * Adds 64-bit value in little endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 64-bit value to be added.
- */
- void net_buf_simple_add_le64(struct net_buf_simple *buf, uint64_t val);
- /**
- * @brief Add 64-bit value at the end of the buffer
- *
- * Adds 64-bit value in big endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 64-bit value to be added.
- */
- void net_buf_simple_add_be64(struct net_buf_simple *buf, uint64_t val);
- /**
- * @brief Remove data from the end of the buffer.
- *
- * Removes data from the end of the buffer by modifying the buffer length.
- *
- * @param buf Buffer to update.
- * @param len Number of bytes to remove.
- *
- * @return New end of the buffer data.
- */
- void *net_buf_simple_remove_mem(struct net_buf_simple *buf, size_t len);
- /**
- * @brief Remove a 8-bit value from the end of the buffer
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 8-bit values.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return The 8-bit removed value
- */
- uint8_t net_buf_simple_remove_u8(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 16 bits from the end of the buffer.
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 16-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 16-bit value converted from little endian to host endian.
- */
- uint16_t net_buf_simple_remove_le16(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 16 bits from the end of the buffer.
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 16-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 16-bit value converted from big endian to host endian.
- */
- uint16_t net_buf_simple_remove_be16(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 24 bits from the end of the buffer.
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 24-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 24-bit value converted from little endian to host endian.
- */
- uint32_t net_buf_simple_remove_le24(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 24 bits from the end of the buffer.
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 24-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 24-bit value converted from big endian to host endian.
- */
- uint32_t net_buf_simple_remove_be24(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 32 bits from the end of the buffer.
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 32-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 32-bit value converted from little endian to host endian.
- */
- uint32_t net_buf_simple_remove_le32(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 32 bits from the end of the buffer.
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 32-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 32-bit value converted from big endian to host endian.
- */
- uint32_t net_buf_simple_remove_be32(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 48 bits from the end of the buffer.
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 48-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 48-bit value converted from little endian to host endian.
- */
- uint64_t net_buf_simple_remove_le48(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 48 bits from the end of the buffer.
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 48-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 48-bit value converted from big endian to host endian.
- */
- uint64_t net_buf_simple_remove_be48(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 64 bits from the end of the buffer.
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 64-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 64-bit value converted from little endian to host endian.
- */
- uint64_t net_buf_simple_remove_le64(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 64 bits from the end of the buffer.
- *
- * Same idea as with net_buf_simple_remove_mem(), but a helper for operating
- * on 64-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 64-bit value converted from big endian to host endian.
- */
- uint64_t net_buf_simple_remove_be64(struct net_buf_simple *buf);
- /**
- * @brief Prepare data to be added to the start of the buffer
- *
- * Modifies the data pointer and buffer length to account for more data
- * in the beginning of the buffer.
- *
- * @param buf Buffer to update.
- * @param len Number of bytes to add to the beginning.
- *
- * @return The new beginning of the buffer data.
- */
- void *net_buf_simple_push(struct net_buf_simple *buf, size_t len);
- /**
- * @brief Copy given number of bytes from memory to the start of the buffer.
- *
- * Modifies the data pointer and buffer length to account for more data
- * in the beginning of the buffer.
- *
- * @param buf Buffer to update.
- * @param mem Location of data to be added.
- * @param len Length of data to be added.
- *
- * @return The new beginning of the buffer data.
- */
- void *net_buf_simple_push_mem(struct net_buf_simple *buf, const void *mem,
- size_t len);
- /**
- * @brief Push 16-bit value to the beginning of the buffer
- *
- * Adds 16-bit value in little endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 16-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_le16(struct net_buf_simple *buf, uint16_t val);
- /**
- * @brief Push 16-bit value to the beginning of the buffer
- *
- * Adds 16-bit value in big endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 16-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_be16(struct net_buf_simple *buf, uint16_t val);
- /**
- * @brief Push 8-bit value to the beginning of the buffer
- *
- * Adds 8-bit value the beginning of the buffer.
- *
- * @param buf Buffer to update.
- * @param val 8-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_u8(struct net_buf_simple *buf, uint8_t val);
- /**
- * @brief Push 24-bit value to the beginning of the buffer
- *
- * Adds 24-bit value in little endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 24-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_le24(struct net_buf_simple *buf, uint32_t val);
- /**
- * @brief Push 24-bit value to the beginning of the buffer
- *
- * Adds 24-bit value in big endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 24-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_be24(struct net_buf_simple *buf, uint32_t val);
- /**
- * @brief Push 32-bit value to the beginning of the buffer
- *
- * Adds 32-bit value in little endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 32-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_le32(struct net_buf_simple *buf, uint32_t val);
- /**
- * @brief Push 32-bit value to the beginning of the buffer
- *
- * Adds 32-bit value in big endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 32-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_be32(struct net_buf_simple *buf, uint32_t val);
- /**
- * @brief Push 48-bit value to the beginning of the buffer
- *
- * Adds 48-bit value in little endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 48-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_le48(struct net_buf_simple *buf, uint64_t val);
- /**
- * @brief Push 48-bit value to the beginning of the buffer
- *
- * Adds 48-bit value in big endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 48-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_be48(struct net_buf_simple *buf, uint64_t val);
- /**
- * @brief Push 64-bit value to the beginning of the buffer
- *
- * Adds 64-bit value in little endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 64-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_le64(struct net_buf_simple *buf, uint64_t val);
- /**
- * @brief Push 64-bit value to the beginning of the buffer
- *
- * Adds 64-bit value in big endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 64-bit value to be pushed to the buffer.
- */
- void net_buf_simple_push_be64(struct net_buf_simple *buf, uint64_t val);
- /**
- * @brief Remove data from the beginning of the buffer.
- *
- * Removes data from the beginning of the buffer by modifying the data
- * pointer and buffer length.
- *
- * @param buf Buffer to update.
- * @param len Number of bytes to remove.
- *
- * @return New beginning of the buffer data.
- */
- void *net_buf_simple_pull(struct net_buf_simple *buf, size_t len);
- /**
- * @brief Remove data from the beginning of the buffer.
- *
- * Removes data from the beginning of the buffer by modifying the data
- * pointer and buffer length.
- *
- * @param buf Buffer to update.
- * @param len Number of bytes to remove.
- *
- * @return Pointer to the old location of the buffer data.
- */
- void *net_buf_simple_pull_mem(struct net_buf_simple *buf, size_t len);
- /**
- * @brief Remove a 8-bit value from the beginning of the buffer
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 8-bit values.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return The 8-bit removed value
- */
- uint8_t net_buf_simple_pull_u8(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 16 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 16-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 16-bit value converted from little endian to host endian.
- */
- uint16_t net_buf_simple_pull_le16(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 16 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 16-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 16-bit value converted from big endian to host endian.
- */
- uint16_t net_buf_simple_pull_be16(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 24 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 24-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 24-bit value converted from little endian to host endian.
- */
- uint32_t net_buf_simple_pull_le24(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 24 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 24-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 24-bit value converted from big endian to host endian.
- */
- uint32_t net_buf_simple_pull_be24(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 32 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 32-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 32-bit value converted from little endian to host endian.
- */
- uint32_t net_buf_simple_pull_le32(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 32 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 32-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 32-bit value converted from big endian to host endian.
- */
- uint32_t net_buf_simple_pull_be32(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 48 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 48-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 48-bit value converted from little endian to host endian.
- */
- uint64_t net_buf_simple_pull_le48(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 48 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 48-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 48-bit value converted from big endian to host endian.
- */
- uint64_t net_buf_simple_pull_be48(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 64 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 64-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 64-bit value converted from little endian to host endian.
- */
- uint64_t net_buf_simple_pull_le64(struct net_buf_simple *buf);
- /**
- * @brief Remove and convert 64 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_simple_pull(), but a helper for operating
- * on 64-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 64-bit value converted from big endian to host endian.
- */
- uint64_t net_buf_simple_pull_be64(struct net_buf_simple *buf);
- /**
- * @brief Get the tail pointer for a buffer.
- *
- * Get a pointer to the end of the data in a buffer.
- *
- * @param buf Buffer.
- *
- * @return Tail pointer for the buffer.
- */
- static inline uint8_t *net_buf_simple_tail(struct net_buf_simple *buf)
- {
- return buf->data + buf->len;
- }
- /**
- * @brief Check buffer headroom.
- *
- * Check how much free space there is in the beginning of the buffer.
- *
- * buf A valid pointer on a buffer
- *
- * @return Number of bytes available in the beginning of the buffer.
- */
- size_t net_buf_simple_headroom(struct net_buf_simple *buf);
- /**
- * @brief Check buffer tailroom.
- *
- * Check how much free space there is at the end of the buffer.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return Number of bytes available at the end of the buffer.
- */
- size_t net_buf_simple_tailroom(struct net_buf_simple *buf);
- /**
- * @brief Check maximum net_buf_simple::len value.
- *
- * This value is depending on the number of bytes being reserved as headroom.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return Number of bytes usable behind the net_buf_simple::data pointer.
- */
- uint16_t net_buf_simple_max_len(struct net_buf_simple *buf);
- /**
- * @brief Parsing state of a buffer.
- *
- * This is used for temporarily storing the parsing state of a buffer
- * while giving control of the parsing to a routine which we don't
- * control.
- */
- struct net_buf_simple_state {
- /** Offset of the data pointer from the beginning of the storage */
- uint16_t offset;
- /** Length of data */
- uint16_t len;
- };
- /**
- * @brief Save the parsing state of a buffer.
- *
- * Saves the parsing state of a buffer so it can be restored later.
- *
- * @param buf Buffer from which the state should be saved.
- * @param state Storage for the state.
- */
- static inline void net_buf_simple_save(struct net_buf_simple *buf,
- struct net_buf_simple_state *state)
- {
- state->offset = net_buf_simple_headroom(buf);
- state->len = buf->len;
- }
- /**
- * @brief Restore the parsing state of a buffer.
- *
- * Restores the parsing state of a buffer from a state previously stored
- * by net_buf_simple_save().
- *
- * @param buf Buffer to which the state should be restored.
- * @param state Stored state.
- */
- static inline void net_buf_simple_restore(struct net_buf_simple *buf,
- struct net_buf_simple_state *state)
- {
- buf->data = buf->__buf + state->offset;
- buf->len = state->len;
- }
- /**
- * Flag indicating that the buffer has associated fragments. Only used
- * internally by the buffer handling code while the buffer is inside a
- * FIFO, meaning this never needs to be explicitly set or unset by the
- * net_buf API user. As long as the buffer is outside of a FIFO, i.e.
- * in practice always for the user for this API, the buf->frags pointer
- * should be used instead.
- */
- #define NET_BUF_FRAGS BIT(0)
- /**
- * Flag indicating that the buffer's associated data pointer, points to
- * externally allocated memory. Therefore once ref goes down to zero, the
- * pointed data will not need to be deallocated. This never needs to be
- * explicitly set or unet by the net_buf API user. Such net_buf is
- * exclusively instantiated via net_buf_alloc_with_data() function.
- * Reference count mechanism however will behave the same way, and ref
- * count going to 0 will free the net_buf but no the data pointer in it.
- */
- #define NET_BUF_EXTERNAL_DATA BIT(1)
- /**
- * @brief Network buffer representation.
- *
- * This struct is used to represent network buffers. Such buffers are
- * normally defined through the NET_BUF_POOL_*_DEFINE() APIs and allocated
- * using the net_buf_alloc() API.
- */
- struct net_buf {
- union {
- /** Allow placing the buffer into sys_slist_t */
- sys_snode_t node;
- /** Fragments associated with this buffer. */
- struct net_buf *frags;
- };
- /** Reference count. */
- uint8_t ref;
- /** Bit-field of buffer flags. */
- uint8_t flags;
- /** Where the buffer should go when freed up. */
- uint8_t pool_id;
- /* Union for convenience access to the net_buf_simple members, also
- * preserving the old API.
- */
- union {
- /* The ABI of this struct must match net_buf_simple */
- struct {
- /** Pointer to the start of data in the buffer. */
- uint8_t *data;
- /** Length of the data behind the data pointer. */
- uint16_t len;
- /** Amount of data that this buffer can store. */
- uint16_t size;
- /** Start of the data storage. Not to be accessed
- * directly (the data pointer should be used
- * instead).
- */
- uint8_t *__buf;
- };
- struct net_buf_simple b;
- };
- /* Actions add start */
- #if defined(CONFIG_NET_BUF_POOL_USAGE)
- uint32_t timestamp;
- #endif
- /* Actions add end */
- /** System metadata for this buffer. */
- uint8_t user_data[CONFIG_NET_BUF_USER_DATA_SIZE] __net_buf_align;
- };
- struct net_buf_data_cb {
- uint8_t * (*alloc)(struct net_buf *buf, size_t *size,
- k_timeout_t timeout);
- uint8_t * (*ref)(struct net_buf *buf, uint8_t *data);
- void (*unref)(struct net_buf *buf, uint8_t *data);
- };
- struct net_buf_data_alloc {
- const struct net_buf_data_cb *cb;
- void *alloc_data;
- /* Actions add start */
- uint16_t data_size;
- /* Actions add end */
- };
- /**
- * @brief Network buffer pool representation.
- *
- * This struct is used to represent a pool of network buffers.
- */
- struct net_buf_pool {
- /** LIFO to place the buffer into when free */
- struct k_lifo free;
- /** Number of buffers in pool */
- const uint16_t buf_count;
- /** Number of uninitialized buffers */
- uint16_t uninit_count;
- #if defined(CONFIG_NET_BUF_POOL_USAGE)
- /** Amount of available buffers in the pool. */
- atomic_t avail_count;
- /** Total size of the pool. */
- const uint16_t pool_size;
- /** Name of the pool. Used when printing pool information. */
- const char *name;
- /* Actions add start */
- /** Actions add, amount of maximize buffers in the pool. */
- int16_t max_used;
- /* Actions add end */
- #endif /* CONFIG_NET_BUF_POOL_USAGE */
- /** Optional destroy callback when buffer is freed. */
- void (*const destroy)(struct net_buf *buf);
- /** Data allocation handlers. */
- const struct net_buf_data_alloc *alloc;
- /** Start of buffer storage array */
- struct net_buf * const __bufs;
- };
- /** @cond INTERNAL_HIDDEN */
- #if defined(CONFIG_NET_BUF_POOL_USAGE)
- #define NET_BUF_POOL_INITIALIZER(_pool, _alloc, _bufs, _count, _destroy) \
- { \
- .free = Z_LIFO_INITIALIZER(_pool.free), \
- .buf_count = _count, \
- .uninit_count = _count, \
- .avail_count = ATOMIC_INIT(_count), \
- .max_used = 0, \
- .name = STRINGIFY(_pool), \
- .destroy = _destroy, \
- .alloc = _alloc, \
- .__bufs = _bufs, \
- }
- #else
- #define NET_BUF_POOL_INITIALIZER(_pool, _alloc, _bufs, _count, _destroy) \
- { \
- .free = Z_LIFO_INITIALIZER(_pool.free), \
- .buf_count = _count, \
- .uninit_count = _count, \
- .destroy = _destroy, \
- .alloc = _alloc, \
- .__bufs = _bufs, \
- }
- #endif /* CONFIG_NET_BUF_POOL_USAGE */
- extern const struct net_buf_data_alloc net_buf_heap_alloc;
- /** @endcond */
- /**
- * @def NET_BUF_POOL_HEAP_DEFINE
- * @brief Define a new pool for buffers using the heap for the data.
- *
- * Defines a net_buf_pool struct and the necessary memory storage (array of
- * structs) for the needed amount of buffers. After this, the buffers can be
- * accessed from the pool through net_buf_alloc. The pool is defined as a
- * static variable, so if it needs to be exported outside the current module
- * this needs to happen with the help of a separate pointer rather than an
- * extern declaration.
- *
- * The data payload of the buffers will be allocated from the heap using
- * k_malloc, so CONFIG_HEAP_MEM_POOL_SIZE must be set to a positive value.
- * This kind of pool does not support blocking on the data allocation, so
- * the timeout passed to net_buf_alloc will be always treated as K_NO_WAIT
- * when trying to allocate the data. This means that allocation failures,
- * i.e. NULL returns, must always be handled cleanly.
- *
- * If provided with a custom destroy callback, this callback is
- * responsible for eventually calling net_buf_destroy() to complete the
- * process of returning the buffer to the pool.
- *
- * @param _name Name of the pool variable.
- * @param _count Number of buffers in the pool.
- * @param _destroy Optional destroy callback when buffer is freed.
- */
- #define NET_BUF_POOL_HEAP_DEFINE(_name, _count, _destroy) \
- static struct net_buf net_buf_##_name[_count] __noinit; \
- static struct net_buf_pool _name __net_buf_align \
- __in_section(_net_buf_pool, static, _name) = \
- NET_BUF_POOL_INITIALIZER(_name, &net_buf_heap_alloc, \
- net_buf_##_name, _count, _destroy)
- struct net_buf_pool_fixed {
- size_t data_size;
- uint8_t *data_pool;
- };
- /** @cond INTERNAL_HIDDEN */
- extern const struct net_buf_data_cb net_buf_fixed_cb;
- /** @endcond */
- /**
- * @def NET_BUF_POOL_FIXED_DEFINE
- * @brief Define a new pool for buffers based on fixed-size data
- *
- * Defines a net_buf_pool struct and the necessary memory storage (array of
- * structs) for the needed amount of buffers. After this, the buffers can be
- * accessed from the pool through net_buf_alloc. The pool is defined as a
- * static variable, so if it needs to be exported outside the current module
- * this needs to happen with the help of a separate pointer rather than an
- * extern declaration.
- *
- * The data payload of the buffers will be allocated from a byte array
- * of fixed sized chunks. This kind of pool does not support blocking on
- * the data allocation, so the timeout passed to net_buf_alloc will be
- * always treated as K_NO_WAIT when trying to allocate the data. This means
- * that allocation failures, i.e. NULL returns, must always be handled
- * cleanly.
- *
- * If provided with a custom destroy callback, this callback is
- * responsible for eventually calling net_buf_destroy() to complete the
- * process of returning the buffer to the pool.
- *
- * @param _name Name of the pool variable.
- * @param _count Number of buffers in the pool.
- * @param _data_size Maximum data payload per buffer.
- * @param _destroy Optional destroy callback when buffer is freed.
- */
- #define NET_BUF_POOL_FIXED_DEFINE(_name, _count, _data_size, _destroy) \
- static struct net_buf net_buf_##_name[_count] __noinit; \
- static uint8_t __noinit net_buf_data_##_name[_count][_data_size]; \
- static const struct net_buf_pool_fixed net_buf_fixed_##_name = { \
- .data_size = _data_size, \
- .data_pool = (uint8_t *)net_buf_data_##_name, \
- }; \
- static const struct net_buf_data_alloc net_buf_fixed_alloc_##_name = {\
- .cb = &net_buf_fixed_cb, \
- .alloc_data = (void *)&net_buf_fixed_##_name, \
- .data_size = _data_size, \
- }; \
- static struct net_buf_pool _name __net_buf_align \
- __in_section(_net_buf_pool, static, _name) = \
- NET_BUF_POOL_INITIALIZER(_name, &net_buf_fixed_alloc_##_name, \
- net_buf_##_name, _count, _destroy)
- /** @cond INTERNAL_HIDDEN */
- extern const struct net_buf_data_cb net_buf_var_cb;
- /** @endcond */
- /**
- * @def NET_BUF_POOL_VAR_DEFINE
- * @brief Define a new pool for buffers with variable size payloads
- *
- * Defines a net_buf_pool struct and the necessary memory storage (array of
- * structs) for the needed amount of buffers. After this, the buffers can be
- * accessed from the pool through net_buf_alloc. The pool is defined as a
- * static variable, so if it needs to be exported outside the current module
- * this needs to happen with the help of a separate pointer rather than an
- * extern declaration.
- *
- * The data payload of the buffers will be based on a memory pool from which
- * variable size payloads may be allocated.
- *
- * If provided with a custom destroy callback, this callback is
- * responsible for eventually calling net_buf_destroy() to complete the
- * process of returning the buffer to the pool.
- *
- * @param _name Name of the pool variable.
- * @param _count Number of buffers in the pool.
- * @param _data_size Total amount of memory available for data payloads.
- * @param _destroy Optional destroy callback when buffer is freed.
- */
- #define NET_BUF_POOL_VAR_DEFINE(_name, _count, _data_size, _destroy) \
- static struct net_buf _net_buf_##_name[_count] __noinit; \
- K_HEAP_DEFINE(net_buf_mem_pool_##_name, _data_size); \
- static const struct net_buf_data_alloc net_buf_data_alloc_##_name = { \
- .cb = &net_buf_var_cb, \
- .alloc_data = &net_buf_mem_pool_##_name, \
- }; \
- static struct net_buf_pool _name __net_buf_align \
- __in_section(_net_buf_pool, static, _name) = \
- NET_BUF_POOL_INITIALIZER(_name, &net_buf_data_alloc_##_name, \
- _net_buf_##_name, _count, _destroy)
- /**
- * @def NET_BUF_POOL_DEFINE
- * @brief Define a new pool for buffers
- *
- * Defines a net_buf_pool struct and the necessary memory storage (array of
- * structs) for the needed amount of buffers. After this,the buffers can be
- * accessed from the pool through net_buf_alloc. The pool is defined as a
- * static variable, so if it needs to be exported outside the current module
- * this needs to happen with the help of a separate pointer rather than an
- * extern declaration.
- *
- * If provided with a custom destroy callback this callback is
- * responsible for eventually calling net_buf_destroy() to complete the
- * process of returning the buffer to the pool.
- *
- * @param _name Name of the pool variable.
- * @param _count Number of buffers in the pool.
- * @param _size Maximum data size for each buffer.
- * @param _ud_size Amount of user data space to reserve.
- * @param _destroy Optional destroy callback when buffer is freed.
- */
- #define NET_BUF_POOL_DEFINE(_name, _count, _size, _ud_size, _destroy) \
- BUILD_ASSERT(_ud_size <= CONFIG_NET_BUF_USER_DATA_SIZE); \
- NET_BUF_POOL_FIXED_DEFINE(_name, _count, _size, _destroy)
- /**
- * @brief Looks up a pool based on its ID.
- *
- * @param id Pool ID (e.g. from buf->pool_id).
- *
- * @return Pointer to pool.
- */
- struct net_buf_pool *net_buf_pool_get(int id);
- /**
- * @brief Get a zero-based index for a buffer.
- *
- * This function will translate a buffer into a zero-based index,
- * based on its placement in its buffer pool. This can be useful if you
- * want to associate an external array of meta-data contexts with the
- * buffers of a pool.
- *
- * @param buf Network buffer.
- *
- * @return Zero-based index for the buffer.
- */
- int net_buf_id(struct net_buf *buf);
- /**
- * @brief Allocate a new fixed buffer from a pool.
- *
- * @param pool Which pool to allocate the buffer from.
- * @param timeout Affects the action taken should the pool be empty.
- * If K_NO_WAIT, then return immediately. If K_FOREVER, then
- * wait as long as necessary. Otherwise, wait until the specified
- * timeout. Note that some types of data allocators do not support
- * blocking (such as the HEAP type). In this case it's still possible
- * for net_buf_alloc() to fail (return NULL) even if it was given
- * K_FOREVER.
- *
- * @return New buffer or NULL if out of buffers.
- */
- #if defined(CONFIG_NET_BUF_LOG)
- struct net_buf *net_buf_alloc_fixed_debug(struct net_buf_pool *pool,
- k_timeout_t timeout, const char *func,
- int line);
- #define net_buf_alloc_fixed(_pool, _timeout) \
- net_buf_alloc_fixed_debug(_pool, _timeout, __func__, __LINE__)
- #else
- struct net_buf *net_buf_alloc_fixed(struct net_buf_pool *pool,
- k_timeout_t timeout);
- #endif
- /**
- * @copydetails net_buf_alloc_fixed
- */
- static inline struct net_buf *net_buf_alloc(struct net_buf_pool *pool,
- k_timeout_t timeout)
- {
- return net_buf_alloc_fixed(pool, timeout);
- }
- /**
- * @brief Allocate a new variable length buffer from a pool.
- *
- * @param pool Which pool to allocate the buffer from.
- * @param size Amount of data the buffer must be able to fit.
- * @param timeout Affects the action taken should the pool be empty.
- * If K_NO_WAIT, then return immediately. If K_FOREVER, then
- * wait as long as necessary. Otherwise, wait until the specified
- * timeout. Note that some types of data allocators do not support
- * blocking (such as the HEAP type). In this case it's still possible
- * for net_buf_alloc() to fail (return NULL) even if it was given
- * K_FOREVER.
- *
- * @return New buffer or NULL if out of buffers.
- */
- #if defined(CONFIG_NET_BUF_LOG)
- struct net_buf *net_buf_alloc_len_debug(struct net_buf_pool *pool, size_t size,
- k_timeout_t timeout, const char *func,
- int line);
- #define net_buf_alloc_len(_pool, _size, _timeout) \
- net_buf_alloc_len_debug(_pool, _size, _timeout, __func__, __LINE__)
- #else
- struct net_buf *net_buf_alloc_len(struct net_buf_pool *pool, size_t size,
- k_timeout_t timeout);
- #endif
- /**
- * @brief Allocate a new buffer from a pool but with external data pointer.
- *
- * Allocate a new buffer from a pool, where the data pointer comes from the
- * user and not from the pool.
- *
- * @param pool Which pool to allocate the buffer from.
- * @param data External data pointer
- * @param size Amount of data the pointed data buffer if able to fit.
- * @param timeout Affects the action taken should the pool be empty.
- * If K_NO_WAIT, then return immediately. If K_FOREVER, then
- * wait as long as necessary. Otherwise, wait until the specified
- * timeout. Note that some types of data allocators do not support
- * blocking (such as the HEAP type). In this case it's still possible
- * for net_buf_alloc() to fail (return NULL) even if it was given
- * K_FOREVER.
- *
- * @return New buffer or NULL if out of buffers.
- */
- #if defined(CONFIG_NET_BUF_LOG)
- struct net_buf *net_buf_alloc_with_data_debug(struct net_buf_pool *pool,
- void *data, size_t size,
- k_timeout_t timeout,
- const char *func, int line);
- #define net_buf_alloc_with_data(_pool, _data_, _size, _timeout) \
- net_buf_alloc_with_data_debug(_pool, _data_, _size, _timeout, \
- __func__, __LINE__)
- #else
- struct net_buf *net_buf_alloc_with_data(struct net_buf_pool *pool,
- void *data, size_t size,
- k_timeout_t timeout);
- #endif
- /**
- * @brief Get a buffer from a FIFO.
- *
- * This function is NOT thread-safe if the buffers in the FIFO contain
- * fragments.
- *
- * @param fifo Which FIFO to take the buffer from.
- * @param timeout Affects the action taken should the FIFO be empty.
- * If K_NO_WAIT, then return immediately. If K_FOREVER, then wait as
- * long as necessary. Otherwise, wait until the specified timeout.
- *
- * @return New buffer or NULL if the FIFO is empty.
- */
- #if defined(CONFIG_NET_BUF_LOG)
- struct net_buf *net_buf_get_debug(struct k_fifo *fifo, k_timeout_t timeout,
- const char *func, int line);
- #define net_buf_get(_fifo, _timeout) \
- net_buf_get_debug(_fifo, _timeout, __func__, __LINE__)
- #else
- struct net_buf *net_buf_get(struct k_fifo *fifo, k_timeout_t timeout);
- #endif
- /**
- * @brief Destroy buffer from custom destroy callback
- *
- * This helper is only intended to be used from custom destroy callbacks.
- * If no custom destroy callback is given to NET_BUF_POOL_*_DEFINE() then
- * there is no need to use this API.
- *
- * @param buf Buffer to destroy.
- */
- static inline void net_buf_destroy(struct net_buf *buf)
- {
- struct net_buf_pool *pool = net_buf_pool_get(buf->pool_id);
- k_lifo_put(&pool->free, buf);
- }
- /**
- * @brief Reset buffer
- *
- * Reset buffer data and flags so it can be reused for other purposes.
- *
- * @param buf Buffer to reset.
- */
- void net_buf_reset(struct net_buf *buf);
- /**
- * @brief Initialize buffer with the given headroom.
- *
- * The buffer is not expected to contain any data when this API is called.
- *
- * @param buf Buffer to initialize.
- * @param reserve How much headroom to reserve.
- */
- void net_buf_simple_reserve(struct net_buf_simple *buf, size_t reserve);
- /**
- * @brief Put a buffer into a list
- *
- * If the buffer contains follow-up fragments this function will take care of
- * inserting them as well into the list.
- *
- * @param list Which list to append the buffer to.
- * @param buf Buffer.
- */
- void net_buf_slist_put(sys_slist_t *list, struct net_buf *buf);
- /**
- * @brief Get a buffer from a list.
- *
- * If the buffer had any fragments, these will automatically be recovered from
- * the list as well and be placed to the buffer's fragment list. This function
- * is NOT thread-safe when recovering fragments.
- *
- * @param list Which list to take the buffer from.
- *
- * @return New buffer or NULL if the FIFO is empty.
- */
- struct net_buf *net_buf_slist_get(sys_slist_t *list);
- /**
- * @brief Put a buffer to the end of a FIFO.
- *
- * If the buffer contains follow-up fragments this function will take care of
- * inserting them as well into the FIFO.
- *
- * @param fifo Which FIFO to put the buffer to.
- * @param buf Buffer.
- */
- void net_buf_put(struct k_fifo *fifo, struct net_buf *buf);
- /**
- * @brief Decrements the reference count of a buffer.
- *
- * The buffer is put back into the pool if the reference count reaches zero.
- *
- * @param buf A valid pointer on a buffer
- */
- #if defined(CONFIG_NET_BUF_LOG)
- void net_buf_unref_debug(struct net_buf *buf, const char *func, int line);
- #define net_buf_unref(_buf) \
- net_buf_unref_debug(_buf, __func__, __LINE__)
- #else
- void net_buf_unref(struct net_buf *buf);
- #endif
- /**
- * @brief Increment the reference count of a buffer.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return the buffer newly referenced
- */
- struct net_buf *net_buf_ref(struct net_buf *buf);
- /**
- * @brief Clone buffer
- *
- * Duplicate given buffer including any data and headers currently stored.
- *
- * @param buf A valid pointer on a buffer
- * @param timeout Affects the action taken should the pool be empty.
- * If K_NO_WAIT, then return immediately. If K_FOREVER, then
- * wait as long as necessary. Otherwise, wait until the specified
- * timeout.
- *
- * @return Cloned buffer or NULL if out of buffers.
- */
- struct net_buf *net_buf_clone(struct net_buf *buf, k_timeout_t timeout);
- /**
- * @brief Get a pointer to the user data of a buffer.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return Pointer to the user data of the buffer.
- */
- static inline void *net_buf_user_data(const struct net_buf *buf)
- {
- return (void *)buf->user_data;
- }
- /**
- * @brief Initialize buffer with the given headroom.
- *
- * The buffer is not expected to contain any data when this API is called.
- *
- * @param buf Buffer to initialize.
- * @param reserve How much headroom to reserve.
- */
- static inline void net_buf_reserve(struct net_buf *buf, size_t reserve)
- {
- net_buf_simple_reserve(&buf->b, reserve);
- }
- /**
- * @brief Prepare data to be added at the end of the buffer
- *
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param len Number of bytes to increment the length with.
- *
- * @return The original tail of the buffer.
- */
- static inline void *net_buf_add(struct net_buf *buf, size_t len)
- {
- return net_buf_simple_add(&buf->b, len);
- }
- /**
- * @brief Copies the given number of bytes to the end of the buffer
- *
- * Increments the data length of the buffer to account for more data at
- * the end.
- *
- * @param buf Buffer to update.
- * @param mem Location of data to be added.
- * @param len Length of data to be added
- *
- * @return The original tail of the buffer.
- */
- static inline void *net_buf_add_mem(struct net_buf *buf, const void *mem,
- size_t len)
- {
- return net_buf_simple_add_mem(&buf->b, mem, len);
- }
- /**
- * @brief Add (8-bit) byte at the end of the buffer
- *
- * Increments the data length of the buffer to account for more data at
- * the end.
- *
- * @param buf Buffer to update.
- * @param val byte value to be added.
- *
- * @return Pointer to the value added
- */
- static inline uint8_t *net_buf_add_u8(struct net_buf *buf, uint8_t val)
- {
- return net_buf_simple_add_u8(&buf->b, val);
- }
- /**
- * @brief Add 16-bit value at the end of the buffer
- *
- * Adds 16-bit value in little endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 16-bit value to be added.
- */
- static inline void net_buf_add_le16(struct net_buf *buf, uint16_t val)
- {
- net_buf_simple_add_le16(&buf->b, val);
- }
- /**
- * @brief Add 16-bit value at the end of the buffer
- *
- * Adds 16-bit value in big endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 16-bit value to be added.
- */
- static inline void net_buf_add_be16(struct net_buf *buf, uint16_t val)
- {
- net_buf_simple_add_be16(&buf->b, val);
- }
- /**
- * @brief Add 24-bit value at the end of the buffer
- *
- * Adds 24-bit value in little endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 24-bit value to be added.
- */
- static inline void net_buf_add_le24(struct net_buf *buf, uint32_t val)
- {
- net_buf_simple_add_le24(&buf->b, val);
- }
- /**
- * @brief Add 24-bit value at the end of the buffer
- *
- * Adds 24-bit value in big endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 24-bit value to be added.
- */
- static inline void net_buf_add_be24(struct net_buf *buf, uint32_t val)
- {
- net_buf_simple_add_be24(&buf->b, val);
- }
- /**
- * @brief Add 32-bit value at the end of the buffer
- *
- * Adds 32-bit value in little endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 32-bit value to be added.
- */
- static inline void net_buf_add_le32(struct net_buf *buf, uint32_t val)
- {
- net_buf_simple_add_le32(&buf->b, val);
- }
- /**
- * @brief Add 32-bit value at the end of the buffer
- *
- * Adds 32-bit value in big endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 32-bit value to be added.
- */
- static inline void net_buf_add_be32(struct net_buf *buf, uint32_t val)
- {
- net_buf_simple_add_be32(&buf->b, val);
- }
- /**
- * @brief Add 48-bit value at the end of the buffer
- *
- * Adds 48-bit value in little endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 48-bit value to be added.
- */
- static inline void net_buf_add_le48(struct net_buf *buf, uint64_t val)
- {
- net_buf_simple_add_le48(&buf->b, val);
- }
- /**
- * @brief Add 48-bit value at the end of the buffer
- *
- * Adds 48-bit value in big endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 48-bit value to be added.
- */
- static inline void net_buf_add_be48(struct net_buf *buf, uint64_t val)
- {
- net_buf_simple_add_be48(&buf->b, val);
- }
- /**
- * @brief Add 64-bit value at the end of the buffer
- *
- * Adds 64-bit value in little endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 64-bit value to be added.
- */
- static inline void net_buf_add_le64(struct net_buf *buf, uint64_t val)
- {
- net_buf_simple_add_le64(&buf->b, val);
- }
- /**
- * @brief Add 64-bit value at the end of the buffer
- *
- * Adds 64-bit value in big endian format at the end of buffer.
- * Increments the data length of a buffer to account for more data
- * at the end.
- *
- * @param buf Buffer to update.
- * @param val 64-bit value to be added.
- */
- static inline void net_buf_add_be64(struct net_buf *buf, uint64_t val)
- {
- net_buf_simple_add_be64(&buf->b, val);
- }
- /**
- * @brief Remove data from the end of the buffer.
- *
- * Removes data from the end of the buffer by modifying the buffer length.
- *
- * @param buf Buffer to update.
- * @param len Number of bytes to remove.
- *
- * @return New end of the buffer data.
- */
- static inline void *net_buf_remove_mem(struct net_buf *buf, size_t len)
- {
- return net_buf_simple_remove_mem(&buf->b, len);
- }
- /**
- * @brief Remove a 8-bit value from the end of the buffer
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 8-bit values.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return The 8-bit removed value
- */
- static inline uint8_t net_buf_remove_u8(struct net_buf *buf)
- {
- return net_buf_simple_remove_u8(&buf->b);
- }
- /**
- * @brief Remove and convert 16 bits from the end of the buffer.
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 16-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 16-bit value converted from little endian to host endian.
- */
- static inline uint16_t net_buf_remove_le16(struct net_buf *buf)
- {
- return net_buf_simple_remove_le16(&buf->b);
- }
- /**
- * @brief Remove and convert 16 bits from the end of the buffer.
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 16-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 16-bit value converted from big endian to host endian.
- */
- static inline uint16_t net_buf_remove_be16(struct net_buf *buf)
- {
- return net_buf_simple_remove_be16(&buf->b);
- }
- /**
- * @brief Remove and convert 24 bits from the end of the buffer.
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 24-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 24-bit value converted from big endian to host endian.
- */
- static inline uint32_t net_buf_remove_be24(struct net_buf *buf)
- {
- return net_buf_simple_remove_be24(&buf->b);
- }
- /**
- * @brief Remove and convert 24 bits from the end of the buffer.
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 24-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 24-bit value converted from little endian to host endian.
- */
- static inline uint32_t net_buf_remove_le24(struct net_buf *buf)
- {
- return net_buf_simple_remove_le24(&buf->b);
- }
- /**
- * @brief Remove and convert 32 bits from the end of the buffer.
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 32-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 32-bit value converted from little endian to host endian.
- */
- static inline uint32_t net_buf_remove_le32(struct net_buf *buf)
- {
- return net_buf_simple_remove_le32(&buf->b);
- }
- /**
- * @brief Remove and convert 32 bits from the end of the buffer.
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 32-bit big endian data.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return 32-bit value converted from big endian to host endian.
- */
- static inline uint32_t net_buf_remove_be32(struct net_buf *buf)
- {
- return net_buf_simple_remove_be32(&buf->b);
- }
- /**
- * @brief Remove and convert 48 bits from the end of the buffer.
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 48-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 48-bit value converted from little endian to host endian.
- */
- static inline uint64_t net_buf_remove_le48(struct net_buf *buf)
- {
- return net_buf_simple_remove_le48(&buf->b);
- }
- /**
- * @brief Remove and convert 48 bits from the end of the buffer.
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 48-bit big endian data.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return 48-bit value converted from big endian to host endian.
- */
- static inline uint64_t net_buf_remove_be48(struct net_buf *buf)
- {
- return net_buf_simple_remove_be48(&buf->b);
- }
- /**
- * @brief Remove and convert 64 bits from the end of the buffer.
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 64-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 64-bit value converted from little endian to host endian.
- */
- static inline uint64_t net_buf_remove_le64(struct net_buf *buf)
- {
- return net_buf_simple_remove_le64(&buf->b);
- }
- /**
- * @brief Remove and convert 64 bits from the end of the buffer.
- *
- * Same idea as with net_buf_remove_mem(), but a helper for operating on
- * 64-bit big endian data.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return 64-bit value converted from big endian to host endian.
- */
- static inline uint64_t net_buf_remove_be64(struct net_buf *buf)
- {
- return net_buf_simple_remove_be64(&buf->b);
- }
- /**
- * @brief Prepare data to be added at the start of the buffer
- *
- * Modifies the data pointer and buffer length to account for more data
- * in the beginning of the buffer.
- *
- * @param buf Buffer to update.
- * @param len Number of bytes to add to the beginning.
- *
- * @return The new beginning of the buffer data.
- */
- static inline void *net_buf_push(struct net_buf *buf, size_t len)
- {
- return net_buf_simple_push(&buf->b, len);
- }
- /**
- * @brief Copies the given number of bytes to the start of the buffer
- *
- * Modifies the data pointer and buffer length to account for more data
- * in the beginning of the buffer.
- *
- * @param buf Buffer to update.
- * @param mem Location of data to be added.
- * @param len Length of data to be added.
- *
- * @return The new beginning of the buffer data.
- */
- static inline void *net_buf_push_mem(struct net_buf *buf, const void *mem,
- size_t len)
- {
- return net_buf_simple_push_mem(&buf->b, mem, len);
- }
- /**
- * @brief Push 8-bit value to the beginning of the buffer
- *
- * Adds 8-bit value the beginning of the buffer.
- *
- * @param buf Buffer to update.
- * @param val 8-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_u8(struct net_buf *buf, uint8_t val)
- {
- net_buf_simple_push_u8(&buf->b, val);
- }
- /**
- * @brief Push 16-bit value to the beginning of the buffer
- *
- * Adds 16-bit value in little endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 16-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_le16(struct net_buf *buf, uint16_t val)
- {
- net_buf_simple_push_le16(&buf->b, val);
- }
- /**
- * @brief Push 16-bit value to the beginning of the buffer
- *
- * Adds 16-bit value in big endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 16-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_be16(struct net_buf *buf, uint16_t val)
- {
- net_buf_simple_push_be16(&buf->b, val);
- }
- /**
- * @brief Push 24-bit value to the beginning of the buffer
- *
- * Adds 24-bit value in little endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 24-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_le24(struct net_buf *buf, uint32_t val)
- {
- net_buf_simple_push_le24(&buf->b, val);
- }
- /**
- * @brief Push 24-bit value to the beginning of the buffer
- *
- * Adds 24-bit value in big endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 24-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_be24(struct net_buf *buf, uint32_t val)
- {
- net_buf_simple_push_be24(&buf->b, val);
- }
- /**
- * @brief Push 32-bit value to the beginning of the buffer
- *
- * Adds 32-bit value in little endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 32-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_le32(struct net_buf *buf, uint32_t val)
- {
- net_buf_simple_push_le32(&buf->b, val);
- }
- /**
- * @brief Push 32-bit value to the beginning of the buffer
- *
- * Adds 32-bit value in big endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 32-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_be32(struct net_buf *buf, uint32_t val)
- {
- net_buf_simple_push_be32(&buf->b, val);
- }
- /**
- * @brief Push 48-bit value to the beginning of the buffer
- *
- * Adds 48-bit value in little endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 48-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_le48(struct net_buf *buf, uint64_t val)
- {
- net_buf_simple_push_le48(&buf->b, val);
- }
- /**
- * @brief Push 48-bit value to the beginning of the buffer
- *
- * Adds 48-bit value in big endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 48-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_be48(struct net_buf *buf, uint64_t val)
- {
- net_buf_simple_push_be48(&buf->b, val);
- }
- /**
- * @brief Push 64-bit value to the beginning of the buffer
- *
- * Adds 64-bit value in little endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 64-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_le64(struct net_buf *buf, uint64_t val)
- {
- net_buf_simple_push_le64(&buf->b, val);
- }
- /**
- * @brief Push 64-bit value to the beginning of the buffer
- *
- * Adds 64-bit value in big endian format to the beginning of the
- * buffer.
- *
- * @param buf Buffer to update.
- * @param val 64-bit value to be pushed to the buffer.
- */
- static inline void net_buf_push_be64(struct net_buf *buf, uint64_t val)
- {
- net_buf_simple_push_be64(&buf->b, val);
- }
- /**
- * @brief Remove data from the beginning of the buffer.
- *
- * Removes data from the beginning of the buffer by modifying the data
- * pointer and buffer length.
- *
- * @param buf Buffer to update.
- * @param len Number of bytes to remove.
- *
- * @return New beginning of the buffer data.
- */
- static inline void *net_buf_pull(struct net_buf *buf, size_t len)
- {
- return net_buf_simple_pull(&buf->b, len);
- }
- /**
- * @brief Remove data from the beginning of the buffer.
- *
- * Removes data from the beginning of the buffer by modifying the data
- * pointer and buffer length.
- *
- * @param buf Buffer to update.
- * @param len Number of bytes to remove.
- *
- * @return Pointer to the old beginning of the buffer data.
- */
- static inline void *net_buf_pull_mem(struct net_buf *buf, size_t len)
- {
- return net_buf_simple_pull_mem(&buf->b, len);
- }
- /**
- * @brief Remove a 8-bit value from the beginning of the buffer
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 8-bit values.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return The 8-bit removed value
- */
- static inline uint8_t net_buf_pull_u8(struct net_buf *buf)
- {
- return net_buf_simple_pull_u8(&buf->b);
- }
- /**
- * @brief Remove and convert 16 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 16-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 16-bit value converted from little endian to host endian.
- */
- static inline uint16_t net_buf_pull_le16(struct net_buf *buf)
- {
- return net_buf_simple_pull_le16(&buf->b);
- }
- /**
- * @brief Remove and convert 16 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 16-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 16-bit value converted from big endian to host endian.
- */
- static inline uint16_t net_buf_pull_be16(struct net_buf *buf)
- {
- return net_buf_simple_pull_be16(&buf->b);
- }
- /**
- * @brief Remove and convert 24 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 24-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 24-bit value converted from little endian to host endian.
- */
- static inline uint32_t net_buf_pull_le24(struct net_buf *buf)
- {
- return net_buf_simple_pull_le24(&buf->b);
- }
- /**
- * @brief Remove and convert 24 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 24-bit big endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 24-bit value converted from big endian to host endian.
- */
- static inline uint32_t net_buf_pull_be24(struct net_buf *buf)
- {
- return net_buf_simple_pull_be24(&buf->b);
- }
- /**
- * @brief Remove and convert 32 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 32-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 32-bit value converted from little endian to host endian.
- */
- static inline uint32_t net_buf_pull_le32(struct net_buf *buf)
- {
- return net_buf_simple_pull_le32(&buf->b);
- }
- /**
- * @brief Remove and convert 32 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 32-bit big endian data.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return 32-bit value converted from big endian to host endian.
- */
- static inline uint32_t net_buf_pull_be32(struct net_buf *buf)
- {
- return net_buf_simple_pull_be32(&buf->b);
- }
- /**
- * @brief Remove and convert 48 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 48-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 48-bit value converted from little endian to host endian.
- */
- static inline uint64_t net_buf_pull_le48(struct net_buf *buf)
- {
- return net_buf_simple_pull_le48(&buf->b);
- }
- /**
- * @brief Remove and convert 48 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 48-bit big endian data.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return 48-bit value converted from big endian to host endian.
- */
- static inline uint64_t net_buf_pull_be48(struct net_buf *buf)
- {
- return net_buf_simple_pull_be48(&buf->b);
- }
- /**
- * @brief Remove and convert 64 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 64-bit little endian data.
- *
- * @param buf A valid pointer on a buffer.
- *
- * @return 64-bit value converted from little endian to host endian.
- */
- static inline uint64_t net_buf_pull_le64(struct net_buf *buf)
- {
- return net_buf_simple_pull_le64(&buf->b);
- }
- /**
- * @brief Remove and convert 64 bits from the beginning of the buffer.
- *
- * Same idea as with net_buf_pull(), but a helper for operating on
- * 64-bit big endian data.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return 64-bit value converted from big endian to host endian.
- */
- static inline uint64_t net_buf_pull_be64(struct net_buf *buf)
- {
- return net_buf_simple_pull_be64(&buf->b);
- }
- /**
- * @brief Check buffer tailroom.
- *
- * Check how much free space there is at the end of the buffer.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return Number of bytes available at the end of the buffer.
- */
- static inline size_t net_buf_tailroom(struct net_buf *buf)
- {
- return net_buf_simple_tailroom(&buf->b);
- }
- /**
- * @brief Check buffer headroom.
- *
- * Check how much free space there is in the beginning of the buffer.
- *
- * buf A valid pointer on a buffer
- *
- * @return Number of bytes available in the beginning of the buffer.
- */
- static inline size_t net_buf_headroom(struct net_buf *buf)
- {
- return net_buf_simple_headroom(&buf->b);
- }
- /**
- * @brief Check maximum net_buf::len value.
- *
- * This value is depending on the number of bytes being reserved as headroom.
- *
- * @param buf A valid pointer on a buffer
- *
- * @return Number of bytes usable behind the net_buf::data pointer.
- */
- static inline uint16_t net_buf_max_len(struct net_buf *buf)
- {
- return net_buf_simple_max_len(&buf->b);
- }
- /**
- * @brief Get the tail pointer for a buffer.
- *
- * Get a pointer to the end of the data in a buffer.
- *
- * @param buf Buffer.
- *
- * @return Tail pointer for the buffer.
- */
- static inline uint8_t *net_buf_tail(struct net_buf *buf)
- {
- return net_buf_simple_tail(&buf->b);
- }
- /**
- * @brief Find the last fragment in the fragment list.
- *
- * @return Pointer to last fragment in the list.
- */
- struct net_buf *net_buf_frag_last(struct net_buf *frags);
- /**
- * @brief Insert a new fragment to a chain of bufs.
- *
- * Insert a new fragment into the buffer fragments list after the parent.
- *
- * Note: This function takes ownership of the fragment reference so the
- * caller is not required to unref.
- *
- * @param parent Parent buffer/fragment.
- * @param frag Fragment to insert.
- */
- void net_buf_frag_insert(struct net_buf *parent, struct net_buf *frag);
- /**
- * @brief Add a new fragment to the end of a chain of bufs.
- *
- * Append a new fragment into the buffer fragments list.
- *
- * Note: This function takes ownership of the fragment reference so the
- * caller is not required to unref.
- *
- * @param head Head of the fragment chain.
- * @param frag Fragment to add.
- *
- * @return New head of the fragment chain. Either head (if head
- * was non-NULL) or frag (if head was NULL).
- */
- struct net_buf *net_buf_frag_add(struct net_buf *head, struct net_buf *frag);
- /**
- * @brief Delete existing fragment from a chain of bufs.
- *
- * @param parent Parent buffer/fragment, or NULL if there is no parent.
- * @param frag Fragment to delete.
- *
- * @return Pointer to the buffer following the fragment, or NULL if it
- * had no further fragments.
- */
- #if defined(CONFIG_NET_BUF_LOG)
- struct net_buf *net_buf_frag_del_debug(struct net_buf *parent,
- struct net_buf *frag,
- const char *func, int line);
- #define net_buf_frag_del(_parent, _frag) \
- net_buf_frag_del_debug(_parent, _frag, __func__, __LINE__)
- #else
- struct net_buf *net_buf_frag_del(struct net_buf *parent, struct net_buf *frag);
- #endif
- /**
- * @brief Copy bytes from net_buf chain starting at offset to linear buffer
- *
- * Copy (extract) @a len bytes from @a src net_buf chain, starting from @a
- * offset in it, to a linear buffer @a dst. Return number of bytes actually
- * copied, which may be less than requested, if net_buf chain doesn't have
- * enough data, or destination buffer is too small.
- *
- * @param dst Destination buffer
- * @param dst_len Destination buffer length
- * @param src Source net_buf chain
- * @param offset Starting offset to copy from
- * @param len Number of bytes to copy
- * @return number of bytes actually copied
- */
- size_t net_buf_linearize(void *dst, size_t dst_len,
- struct net_buf *src, size_t offset, size_t len);
- /**
- * @typedef net_buf_allocator_cb
- * @brief Network buffer allocator callback.
- *
- * @details The allocator callback is called when net_buf_append_bytes
- * needs to allocate a new net_buf.
- *
- * @param timeout Affects the action taken should the net buf pool be empty.
- * If K_NO_WAIT, then return immediately. If K_FOREVER, then
- * wait as long as necessary. Otherwise, wait until the specified
- * timeout.
- * @param user_data The user data given in net_buf_append_bytes call.
- * @return pointer to allocated net_buf or NULL on error.
- */
- typedef struct net_buf *(*net_buf_allocator_cb)(k_timeout_t timeout,
- void *user_data);
- /**
- * @brief Append data to a list of net_buf
- *
- * @details Append data to a net_buf. If there is not enough space in the
- * net_buf then more net_buf will be added, unless there are no free net_buf
- * and timeout occurs. If not allocator is provided it attempts to allocate from
- * the same pool as the original buffer.
- *
- * @param buf Network buffer.
- * @param len Total length of input data
- * @param value Data to be added
- * @param timeout Timeout is passed to the net_buf allocator callback.
- * @param allocate_cb When a new net_buf is required, use this callback.
- * @param user_data A user data pointer to be supplied to the allocate_cb.
- * This pointer is can be anything from a mem_pool or a net_pkt, the
- * logic is left up to the allocate_cb function.
- *
- * @return Length of data actually added. This may be less than input
- * length if other timeout than K_FOREVER was used, and there
- * were no free fragments in a pool to accommodate all data.
- */
- size_t net_buf_append_bytes(struct net_buf *buf, size_t len,
- const void *value, k_timeout_t timeout,
- net_buf_allocator_cb allocate_cb, void *user_data);
- /**
- * @brief Skip N number of bytes in a net_buf
- *
- * @details Skip N number of bytes starting from fragment's offset. If the total
- * length of data is placed in multiple fragments, this function will skip from
- * all fragments until it reaches N number of bytes. Any fully skipped buffers
- * are removed from the net_buf list.
- *
- * @param buf Network buffer.
- * @param len Total length of data to be skipped.
- *
- * @return Pointer to the fragment or
- * NULL and pos is 0 after successful skip,
- * NULL and pos is 0xffff otherwise.
- */
- static inline struct net_buf *net_buf_skip(struct net_buf *buf, size_t len)
- {
- while (buf && len--) {
- net_buf_pull_u8(buf);
- if (!buf->len) {
- buf = net_buf_frag_del(NULL, buf);
- }
- }
- return buf;
- }
- /**
- * @brief Calculate amount of bytes stored in fragments.
- *
- * Calculates the total amount of data stored in the given buffer and the
- * fragments linked to it.
- *
- * @param buf Buffer to start off with.
- *
- * @return Number of bytes in the buffer and its fragments.
- */
- static inline size_t net_buf_frags_len(struct net_buf *buf)
- {
- size_t bytes = 0;
- while (buf) {
- bytes += buf->len;
- buf = buf->frags;
- }
- return bytes;
- }
- /* Actions add start */
- struct net_buf_pool_continue {
- uint8_t init_flag;
- uint16_t data_size;
- uint8_t *data_pool;
- uint8_t *alloc_pos;
- uint16_t curr_used;
- uint16_t max_used;
- };
- extern const struct net_buf_data_cb net_buf_continue_cb;
- #define BT_BUF_POOL_ALLOC_DATA_DEFINE(_name, _size) \
- static u8_t _net_data_##_name[ROUND_UP((_size), 4)] __net_buf_align __noinit; \
- struct net_buf_pool_continue _name = { \
- .init_flag = 0, \
- .data_size = _size, \
- .data_pool = _net_data_##_name, \
- }
- #define NET_BUF_POOL_CONTINUE_DEFINE(_name, _count, _size, _destroy, _alloc_data) \
- static struct net_buf net_buf_##_name[_count] __noinit; \
- static const struct net_buf_data_alloc net_buf_continue_alloc_##_name = {\
- .cb = &net_buf_continue_cb, \
- .alloc_data = _alloc_data, \
- .data_size = _size, \
- }; \
- struct net_buf_pool _name __net_buf_align \
- __in_section(_net_buf_pool, static, _name) = \
- NET_BUF_POOL_INITIALIZER(_name, &net_buf_continue_alloc_##_name, \
- net_buf_##_name, _count, _destroy)
- #define BT_BUF_POOL_DEFINE(_name, _count, _size, _ud_size, _destroy, _alloc_data) \
- BUILD_ASSERT(_ud_size <= CONFIG_NET_BUF_USER_DATA_SIZE); \
- NET_BUF_POOL_CONTINUE_DEFINE(_name, _count, (_size + _ud_size), _destroy, _alloc_data)
- /* Actions add end */
- /**
- * @}
- */
- #ifdef __cplusplus
- }
- #endif
- #endif /* ZEPHYR_INCLUDE_NET_BUF_H_ */
|