init(3)

📦
version 1.75 · 8 versions
, in debian trixie, ubuntu noble, ubuntu questing

✨ init(3) — the bcm2835 library glow-up page ✨

okay bestie, welcome to init(3) 💖 this is the Library Functions Manual page for the bcm2835 library, and it's literally the page you read before you touch anything else. no cap.

🌸 NAME 🌸

init — Library initialisation and management 🎀

like... starting the library up and shutting it down. the whole vibe check. 💅

🦋 SYNOPSIS 🦋

Functions

int bcm2835_init (void)
int bcm2835_close (void)
void bcm2835_set_debug (uint8_t debug)
unsigned int bcm2835_version (void)

that's it, that's the whole roster. four little icons 👑

🌈 Detailed Description 🌈

These functions let you initialise and control the bcm2835 library. that's the entire assignment, and they ate. 🔥

💖 Function Documentation 💖

🫶 int bcm2835_close (void) [extern]

closes the library, deallocating any allocated memory and closing /dev/mem 🫧

like when you leave the party and you actually turn the lights off. main character behaviour.

Returns

1 if successful else 0 ✨

👑 int bcm2835_init (void) [extern]

Initialises the library by opening /dev/mem (if you are root) or /dev/gpiomem (if you are not) and getting pointers to the internal memory for BCM 2835 device registers. 🧚

You must call this (successfully) before calling any other functions in this library — the only exception is bcm2835_set_debug. fr fr.

If bcm2835_init() fails by returning 0, calling any other function may result in crashes or other failures. 💀

If bcm2835_init() succeeds but you are not running as root, then only gpio operations are permitted, and calling any other functions may result in crashes or other failures. 😭

. Prints messages to stderr in case of errors. (yes that stray period is in the original, we respect the original 🎀)

Returns

1 if successful else 0 ⭐

🎀 void bcm2835_set_debug (uint8_t debug) [extern]

Sets the debug level of the library. 🐛

  • A value of 1 prevents mapping to /dev/mem, and makes the library print out what it would do, rather than accessing the GPIO registers. it's giving "pretend mode", and honestly? iconic.
  • A value of 0, the default, causes normal operation.

Call this before calling bcm2835_init(); — order matters, bestie. 🙈

Parameters

  • debug — The new debug level. 1 means debug.

🌟 unsigned int bcm2835_version (void) [extern]

Returns the version number of the library, same as BCM2835_VERSION. lowkey the easiest function on this whole page. 🍓

Returns

the current library version number 💜

🌸 Author 🌸

Generated automatically by Doxygen for bcm2835 from the source code. (the robots did this one, we just added the glitter ✨)

and that's the whole page, babe! 🦋 this init(3) came to you from the bcm2835 library, Version 1.75 — screenshot it, bookmark it, keep it in the group chat, iykyk. mwah 💅💖

📦 where this page comes from