topic Re: Why do the FlexCAN SDK v2.0 functions mix lowercase and uppercase "L" in the function names? in Kinetis Software Development Kit

Why do the FlexCAN SDK v2.0 functions mix lowercase and uppercase "L" in the function names?

kylemanna — Thu, 12 May 2016 03:00:46 GMT

Was confused by a linker problem to discover the API is strange. Consider the following function list:

FLEXCAN_Init

FLEXCAN_Deinit

FLEXCAN_GetDefaultConfig

FLEXCAN_SetTimingConfig

FlEXCAN_SetRxMbGlobalMask

FlEXCAN_SetRxFifoGlobalMask

FlEXCAN_SetRxIndividualMask

FLEXCAN_SetTxMbConfig

FLEXCAN_SetRxMbConfig

FlEXCAN_SetRxFifoConfig

FLEXCAN_GetStatusFlags

FLEXCAN_ClearStatusFlags

FlEXCAN_GetBusErrCount

FLEXCAN_GetMbStatusFlags

FLEXCAN_ClearMbStatusFlags

FLEXCAN_EnableInterrupts

FLEXCAN_DisableInterrupts

FLEXCAN_EnableMbInterrupts

FLEXCAN_DisableMbInterrupts

FLEXCAN_Enable

FLEXCAN_WriteTxMb

FLEXCAN_ReadRxMb

FlEXCAN_ReadRxFifo

FlEXCAN_TransferSendBlocking

FlEXCAN_TransferReceiveBlocking

FlEXCAN_TransferReceiveFifoBlocking

FLEXCAN_TransferCreateHandle

FLEXCAN_TransferSendNonBlocking

FLEXCAN_TransferReceiveNonBlocking

FLEXCAN_TransferReceiveFifoNonBlocking

FLEXCAN_TransferAbortSend

FLEXCAN_TransferAbortReceive

FLEXCAN_TransferAbortReceiveFifo

FLEXCAN_TransferHandleIRQ

Some have the "FLEXCAN_" prefix while many have the "FlEXCAN_" prefix. Why the lowercase "L"? It appears this way in the documentation as well: Kinetis SDK 2.0 API Reference Manual: FlexCAN Driver

Re: Why do the FlexCAN SDK v2.0 functions mix lowercase and uppercase "L" in the function names?

Jmart — Thu, 12 May 2016 14:43:01 GMT

This is not intentional. I'll ask the team to correct this immediately.

Thanks for bringing this to my attention.

Jason

Re: Why do the FlexCAN SDK v2.0 functions mix lowercase and uppercase "L" in the function names?

kylemanna — Thu, 12 May 2016 16:10:29 GMT

Hi Jason,

Thanks for addressing this. Look forward to the next release!

- Kyle

Re: Why do the FlexCAN SDK v2.0 functions mix lowercase and uppercase "L" in the function names?

kylemanna — Fri, 13 May 2016 03:06:40 GMT

Hi again Jmart,

One other minor comment: the internal API has two static function named FLEXCAN_EnterFrazeMode() and FLEXCAN_ExitFrazeMode(). I assume these are referring the the "Freeze" mode of the FlexCAN peripheral? If someone is going to be cleaning up the public API, might be handy to rename these as well.

I like my CAN peripherals like I like my movies: Frozen.

Cheers!

Re: Why do the FlexCAN SDK v2.0 functions mix lowercase and uppercase "L" in the function names?

Jmart — Fri, 13 May 2016 12:55:57 GMT

Kyle,

Spoke with the team and they have already cleaned up both issues in the latest FlexCAN driver.

Jasno