C Preprocessor concatenation

[daans]

Hi,

I am working on an embedded C project where I'd like to define my ports and their bits as follows:
#define RF_SPI0_MOSI_BIT 1
#define RF_SPI0_MOSI_PORT 3

Now, when I set a pin (Port 3, pin 1) as an output:
P3DIR |= 1 << 1;

The first macro I created was :
#define _PORT_SET_OUTPUT(port, pin) P##port##DIR |= 1 << pin

_PORT_SET_OUTPUT(1, 3);, which works.

It would be way easier if I give my macro only the value 'RF_SPI0_MOSI', and let the macro find out the port.

PORT_SET_OUTPUT(RF_SPI0_MOSI);

Where the macro will concatenate the RF_SPI0_MOSI value with '_PORT' and '_PIN'.

I was not able to google any information about this, could anybody tell me if this is possible, and if so, help me out?

[whiteflags]

You can definitely do something like

#define PORT_SET_OUTPUT_SIMPLE PORT_SET_OUTPUT(RF_SPI0_MOSI_PORT, RF_SPI0_MOSI_BIT)

and then the statement is generated where "PORT_SET_OUTPUT_SIMPLE;" is used.

Personally I think this is a step too far and that the function is the simplest thing to understand.

[daans]

You can definitely do something like

#define PORT_SET_OUTPUT_SIMPLE PORT_SET_OUTPUT(RF_SPI0_MOSI_PORT, RF_SPI0_MOSI_BIT)

and then the statement is generated where "PORT_SET_OUTPUT_SIMPLE;" is used.

Personally I think this is a step too far and that the function is the simplest thing to understand.

Thanks for helping me out here.
The macro is used for more than just port1 bit3, There are more than 100 pins I have to define, so the method you are describing is not the way I would like to use in my program.


lets say; ..

#define RF_SPI0_MOSI_BIT                   1
#define RF_SPI0_MOSI_PORT                3
#define RF_SPI0_MISO_BIT                   2
#define RF_SPI0_MISO_PORT                P3
#define RF_SPI0_SCLK_BIT                   3
#define RF_SPI0_SCLK_PORT                P3
#define LED_RED_BIT                           0
#define LED_RED_PORT                        P4

void initIO(void)
{
  PORT_SET_OUTPUT(RF_SPI0_MOSI);
  PORT_SET_INPUT(RF_SPI0_MISO);
  PORT_SET_OUTPUT(RF_SPI0_SCLK);
  PORT_SET_OUTPUT(LED_RED);
  PORT_SET_INPUT..

  etc.
}

We have been using this method on several other processors, but those used another structure of initializing ports. For this reason I can not use the port initialize code used on these processors, but I would like to remain the macros.

also, the method you are describing will parse an error during preprocessing:
PORT_SET_OUTPUT(RF_SPI0_MOSI_PORT, RF_SPI0_MOSI_BIT) -> Description Resource Path Location Type
#20 identifier "PRF_SPI0_MOSI_PORTDIR" is undefined main.c /CC1200_Tester/src line 40 C/C++ Problem


It currently will only work with numerical values.

[whiteflags]

Well do you have to set each pin individually? That seems really stupid. I can tell you that having 100+ macros for each pin is going to get unruly when you could set a whole bunch of pins at once. Your original attempt was good I would just use a mask instead.

#define USE_PORT(portnum) P##portnum##DIR
#define PORT_SET_OUTPUT(port, mask) USEPORT(port) |= (mask)

Label all of the port numbers since they are (hopefully) fewer in number and more important. Then instead of trying to label all of the pins, come up with specific integers that turn on all the pins you need to use at once. For example maybe 0xB (1011) turns on pins 0, 2, and 3. To help you come up with such integers, you ought to read this: BBC Bitesize - GCSE Computer Science - Hexadecimal and character sets - Revision 1 , especially if you are unfamiliar with hex's relationship to binary.

[daans]

Well do you have to set each pin individually? That seems really stupid. I can tell you that having 100+ macros for each pin is going to get unruly when you could set a whole bunch of pins at once. Your original attempt was good I would just use a mask instead.

#define USE_PORT(portnum) P##portnum##DIR
#define PORT_SET_OUTPUT(port, mask) USEPORT(port) |= (mask)

Label all of the port numbers since they are (hopefully) fewer in number and more important. Then instead of trying to label all of the pins, come up with specific integers that turn on all the pins you need to use at once. For example maybe 0xB (1011) turns on pins 0, 2, and 3. To help you come up with such integers, you ought to read this: BBC Bitesize - GCSE Computer Science - Hexadecimal and character sets - Revision 1 , especially if you are unfamiliar with hex's relationship to binary.

Yes Each port Will be labeled as port and pin , this label process is executed by a script that generates the labels from a pcb design file. I Will test the method in 60 minutes, keep you up to date

[daans]

Well do you have to set each pin individually? That seems really stupid. I can tell you that having 100+ macros for each pin is going to get unruly when you could set a whole bunch of pins at once. Your original attempt was good I would just use a mask instead.

#define USE_PORT(portnum) P##portnum##DIR
#define PORT_SET_OUTPUT(port, mask) USEPORT(port) |= (mask)

Label all of the port numbers since they are (hopefully) fewer in number and more important. Then instead of trying to label all of the pins, come up with specific integers that turn on all the pins you need to use at once. For example maybe 0xB (1011) turns on pins 0, 2, and 3. To help you come up with such integers, you ought to read this: BBC Bitesize - GCSE Computer Science - Hexadecimal and character sets - Revision 1 , especially if you are unfamiliar with hex's relationship to binary.

Labels are generated by a script that's initialized by an output file of the PCB layout.
So when I would like to change the output of a pin, I would do something like this;

PORT_SET_OUTPUT(RF_SPI_MISO);//one time, initializing
PORT_HIGH(RF_SPI_MISO);


I only have to write the macro's for editing the registers.

[whiteflags]

also, the method you are describing will parse an error during preprocessing:
PORT_SET_OUTPUT(RF_SPI0_MOSI_PORT, RF_SPI0_MOSI_BIT) -> Description Resource Path Location Type
#20 identifier "PRF_SPI0_MOSI_PORTDIR" is undefined main.c /CC1200_Tester/src line 40 C/C++ Problem

It currently will only work with numerical values.

That was my bad. I did something incorrect, but happily the error led to the solution!

I need to explain something to you. Ordinarily, macros are not expanded when you use them in stringification # or pasting ##:

#define CAT  dog
#define FOOD hot_##CAT
FOOD

FOOD produces hot_CAT, not hot_dog like we want, but you can get around it. Arguments to a macro must be expanded before they are passed to another macro though, so we should be able to do what you want. One macro to expand, and one to do the pasting.

Just to show it with the example:

#define CAT     dog
#define NOEXPAND(A) hot_##A
#define FOOD(A) NOEXPAND(A)
FOOD(CAT)

produces hot_dog as wanted. So we can do what you want with pasting PORT and BIT, it just takes careful control of where things expand and where they shouldn't.

C:\Users\jk>more macros.c
#define PASTE_BIT(m) m##_BIT
#define PASTE_PORT(m) m##_PORT

#define USE_PORT(port) P##port##DIR
#define PORT_SET_OUTPUT(port, pin) USE_PORT(port) |= 1 << (pin)

/* you must define ports and pins at this point */
#define RF_SPI0_MOSI_PORT 3
#define RF_SPI0_MISO_PORT 3
#define RF_SPI0_SCLK_PORT 3
#define LED_RED_PORT 4
#define RF_SPI0_MOSI_BIT 1
#define RF_SPI0_MISO_BIT 2
#define RF_SPI0_SCLK_BIT 3
#define LED_RED_BIT 0

PORT_SET_OUTPUT(PASTE_PORT(RF_SPI0_MOSI), PASTE_BIT(RF_SPI0_MOSI))
PORT_SET_OUTPUT(PASTE_PORT(RF_SPI0_MISO), PASTE_BIT(RF_SPI0_MISO))
PORT_SET_OUTPUT(PASTE_PORT(RF_SPI0_SCLK), PASTE_BIT(RF_SPI0_SCLK))
PORT_SET_OUTPUT(PASTE_PORT(LED_RED), PASTE_BIT(LED_RED))

C:\Users\jk>gcc -E macros.c
# 1 "macros.c"
# 1 "<built-in>"
# 1 "<command-line>"
# 1 "macros.c"
# 21 "macros.c"
P3DIR |= 1 << (1)
P3DIR |= 1 << (2)
P3DIR |= 1 << (3)
P4DIR |= 1 << (0)

So that should be good. Hopefully the explanation is clear so that you can do this yourself. I notice that in some other examples you posted you use macros that I haven't seen before, but the solution for those would be similar to this including possibly functions like USE_PORT(x) so they expand to what you want.