Skip to content

tc6: align all declaration and definition parameter names #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tkummermehr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

tc6: align all declaration and definition parameter names #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions libtc6/inc/tc6-regs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ bool TC6Regs_GetInitDone(TC6_t *pInst);

/** \brief Reinitializes the LAN865x with its default register settings and the stored values given by TC6Regs_Init()
* \note Call this function after a serious error.
* \param pInst - The pointer returned by TC6_Init.
* \param pTC6 - The pointer returned by TC6_Init.
*/
void TC6Regs_Reinit(TC6_t *pInst);
void TC6Regs_Reinit(TC6_t *pTC6);

/** \brief Sets the PLCA Node ID and the PLCA Node Count and can enable/disable PLCA.
* \param pInst - The pointer returned by TC6_Init.
Expand All @@ -125,10 +125,10 @@ void TC6Regs_Reinit(TC6_t *pInst);
bool TC6Regs_SetPlca(TC6_t *pInst, bool plcaEnable, uint8_t nodeId, uint8_t nodeCount);

/** \brief Returns the LAN865x Revision number.
* \param pInst - The pointer returned by TC6_Init.
* \param pTC6 - The pointer returned by TC6_Init.
* \return 0, in case of error. Otherwise, Chip Revision.
*/
uint8_t TC6Regs_GetChipRevision(TC6_t *pInst);
uint8_t TC6Regs_GetChipRevision(TC6_t *pTC6);

/**
* \brief Fetch the string for the given event value.
Expand Down
20 changes: 10 additions & 10 deletions libtc6/inc/tc6.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ bool TC6_Service(TC6_t *pInst, bool interruptLevel);
* \param pInst - The pointer returned by TC6_Init.
* \param interruptLevel - The level of the interrupt pin. false is interpreted as interrupt active. true is interpreted as currently no interrupt issued.
*/
void TC6_EnableData(TC6_t *pInst, bool enable);
void TC6_EnableData(TC6_t *g, bool enable);

/** \brief Sends a raw Ethernet packet.
* \param pInst - The pointer returned by TC6_Init.
Expand All @@ -170,7 +170,7 @@ bool TC6_SendRawEthernetPacket(TC6_t *pInst, const uint8_t *pTx, uint16_t len, u
* \param pSegments - Pointer of the raw segments will be written to the given address. NULL if there is no buffer available.
* \return TC6_TX_ETH_MAX_SEGMENTS if send buffer is available. 0, otherwise.
*/
uint8_t TC6_GetRawSegments(TC6_t *pInst, TC6_RawTxSegment **pSegments);
uint8_t TC6_GetRawSegments(TC6_t *g, TC6_RawTxSegment **pSegments);

/** \brief Sends a raw Ethernet packet out of several Ethernet segments.
* \param pInst - The pointer returned by TC6_Init.
Expand Down Expand Up @@ -231,14 +231,14 @@ bool TC6_ReadModifyWriteRegister(TC6_t *pInst, uint32_t addr, uint32_t value, ui
* \note Each map entry is issued as its own single-register SPI control transaction. True multi-register bursts are not currently implemented; the map is a convenience wrapper, not a performance optimization.
* \return The amount of register commands enqueued. May return 0 when queue is total full. May return less then mapLength when queue is partly full.
*/
uint16_t TC6_MultipleRegisterAccess(TC6_t *pInst, const MemoryMap_t *pMap, uint16_t mapLength, TC6_RegCallback_t multipleCallback, void *pTag);
uint16_t TC6_MultipleRegisterAccess(TC6_t *g, const MemoryMap_t *pMap, uint16_t mapLength, TC6_RegCallback_t multipleCallback, void *pTag);


/** \brief Reenable the reporting of extended status flag via TC6_CB_OnExtendedStatus() callback.
* \note This feature was introduced to not trigger thousands of extended status callbacks, when there is a lot of traffic ongoing.
* \param pInst - The pointer returned by TC6_Init.
*/
void TC6_UnlockExtendedStatus(TC6_t *pInst);
void TC6_UnlockExtendedStatus(TC6_t *g);

/**
* \brief The user must call this function once the SPI transaction is finished.
Expand All @@ -255,32 +255,32 @@ void TC6_SpiBufferDone(uint8_t tc6instance, bool success);
/** \brief Destroy the given TC6 instance and release resources allocated by it.
* \param pInst - The pointer returned by TC6_Init.
*/
void TC6_Destroy(TC6_t *pInst);
void TC6_Destroy(TC6_t *g);

/** \brief Reset all internal state machines and queues
* \param pInst - The pointer returned by TC6_Init.
*/
void TC6_Reset(TC6_t *pInst);
void TC6_Reset(TC6_t *g);

/** \brief Returns the TC6 related status variables such as TX and RX credit counter and if the controller is in sync state.
* \param pInst - The pointer returned by TC6_Init.
* \param pTxCredit - Pointer to a TX credit variable. This function writes the current TX credit value into this variable. NULL pointer is accepted.
* \param pRxCredit - Pointer to a RX credit variable. This function writes the current RX value into this variable. NULL pointer is accepted.
* \param pSynced - Pointer to a synced variable. This function writes the current synced state into this variable. NULL pointer is accepted.
*/
void TC6_GetState(TC6_t *pInst, uint8_t *pTxCredit, uint8_t *pRxCredit, bool *pSynced);
void TC6_GetState(TC6_t *g, uint8_t *pTxCredit, uint8_t *pRxCredit, bool *pSynced);

/** \brief Returns the current instance number of the given TC6 pointer
* \param pInst - The pointer returned by TC6_Init.
* \return Instance number, starting with 0 for the first instance
*/
uint8_t TC6_GetInstance(TC6_t *pInst);
uint8_t TC6_GetInstance(TC6_t *g);

/**
* \brief Fetch the string for the given error value.
* \param event - Enumeration matching to the occurred event.
* \param error - Enumeration matching to the occurred error.
*/
const char * TC6_GetErrorStr(TC6_Error_t event);
const char * TC6_GetErrorStr(TC6_Error_t error);

/*>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>*/
/* CALLBACK SECTION */
Expand Down
6 changes: 3 additions & 3 deletions libtc6/src/tc6.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ static inline void SET_VAL(uint8_t bytePos, uint8_t bitpos, uint8_t width, uint8
static void initializeSpiEntry(struct qspibuf *newEntry);
static uint16_t getTrail(TC6_t *g, bool enqueueEmpty);
static void addEmptyChunks(TC6_t *g, struct qspibuf *entry, bool enqueueEmpty);
static bool serviceData(TC6_t *g, bool enqueueEmpty);
static bool serviceData(TC6_t *g, bool sendEmpty);
static bool serviceControl(TC6_t *g);
static bool spiTransaction(TC6_t *g, uint8_t *pTx, uint8_t *pRx, uint16_t len, SpiOp_t op);
static bool modify(TC6_t *g, uint32_t value);
Expand All @@ -208,8 +208,8 @@ static bool accessRegisters(TC6_t *g, enum register_op_type op, uint32_t addr, u
static void processDataRx(TC6_t *g);

/* Protocol Implementation */
static uint16_t mk_ctrl_req(bool wnr, bool aid, uint32_t addr, uint8_t num_regs, const uint32_t *regs, uint8_t *buff, uint16_t size_of_buff);
static uint16_t mk_secure_ctrl_req(bool wnr, bool aid, uint32_t addr, uint8_t num_regs, const uint32_t *regs, uint8_t *buff, uint16_t size_of_buff);
static uint16_t mk_ctrl_req(bool wnr, bool aid, uint32_t addr, uint8_t num_regs, const uint32_t *regs, uint8_t *tx_buf, uint16_t tx_buf_size);
static uint16_t mk_secure_ctrl_req(bool wnr, bool aid, uint32_t addr, uint8_t num_regs, const uint32_t *regs, uint8_t *tx_buf, uint16_t tx_buf_size);
static uint16_t read_rx_ctrl_buffer(const uint8_t *rx_buf, uint16_t rx_buf_size, uint32_t *regs_buf, uint8_t regs_buf_size, bool secure);
static uint16_t mk_data_tx(TC6_t *g, uint8_t *tx_buf, uint16_t tx_buf_len);
static void enqueue_rx_spi(TC6_t *g, const uint8_t *buff, uint16_t buf_len);
Expand Down